about_venvlink-autoenv.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Automatically activate and deactivate python virtual environments created with [venvlink](https://github.com/np-8/venvlink) on Powershell.
 
![](example-usage.gif)
# What is it?
 
The [venvlink](https://github.com/np-8/venvlink) creates a folder called `venv` into the root of the project directory. This folder contains `venvlink-autoenv.ps1` and `venvlink-autoenv.leave.ps1` files which can be automatically called by `venvlink-autoenv` to activate / deactivate the linked virtual environment.
 
## Features
- When you enter a project folder (including subdirectories) which has virtual environment link created with [venvlink](https://github.com/np-8/venvlink), the virtual environment will be **automatically activated**.
- When you leave the project folder, the virtual environment is **automatically deactivated**.
- For security reasons, before automatically running the activation/deactivation scripts, `venvlink-autoenv` asks for authorization of the script. It stores the full file path and the MD5 hash of the file contents to a file (`~/venvlink-autoenv-auth`). *This is done only the first time for each file.*
 
 
# Installing
 
Run the following command in the Powershell to download the package from [PowerShell Gallery](https://www.powershellgallery.com/):
```
Install-Module venvlink-autoenv
```
 
Then, run
```
Add-Content $PROFILE @("`n", "import-module venvlink-autoenv")
```
to make the `venvlink-autoenv` available in every Powershell session you start.
 
**Note**: If you use many versions of Powershell (Powershell 5.1, Powershell 6, Powershell 7), you might need to install the `venvlink-autovenv` to each of the separately.
# Usage
 
After installation, just use Powershell to locate into any folder with virtual environment created with venvlink.
 
 
 
# Credits
 
- venvlink-autovenv was built on top of [ps-autoenv](https://github.com/nickcox/ps-autoenv) by [Nick Cox](https://github.com/nickcox).