Skip to content

Latest commit

 

History

History
98 lines (72 loc) · 2.9 KB

README.md

File metadata and controls

98 lines (72 loc) · 2.9 KB

Light_Venv_Switch

Automated Virtualenv venv switch for projects<>

last-commit repo-top-language repo-language-count

Table of Contents

📍 Overview

The ligth venv switch activates and deactivate the virtual environment for a project by entering or leaving automaticly. It's a simple .zsh plugin that can be used with zap or oh-my-zsh.


🧩 Features

Feature Description
🔌 Integrations Can be used as a plugin for zap or oh-my-zsh

🚀 Getting Started

System Requirements

  • zsh: zsh or oh-my-zsh / zap installed

⚙️ Installation

From source

  1. zap / Clone the repository to your zsh plugins directory:
$ git clone https://github.com/andreasbaumgartner/light-venv-switch.git "$HOME/.locacl/share/zap/plugins/light-venv-switch"
  1. Oh-my-zsh / Clone the repository to your zsh plugins directory:
$ git clone https://github.com/andreasbaumgartner/light-venv-switch.git "$HOME/.oh-my-zsh/custom/plugins/light-venv-switch"

🤖 Usage

From source

Run light-venv-switch using one of the following commands:

$ cd my_project

The plugin will automatically activate the virtual environment for the project.

$ cd my_project
$ 👉 Virtualenv activated 🚀

To deactivate the virtual environment, simply leave the project directory.

$ cd ..
$ 👉 Virtualenv deactivated 🤓

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

  • Report Issues: Submit bugs found or log feature requests for the light-venv-switch project.

📄 License

This project is free to use. There are no guarantees or warranties. Please see the LICENSE file formore information.