Emit the activation command for the nearest Python virtual environment and install shell bootstrap wrappers.
Project description
envon
Emit the activation command for the nearest or specified Python virtual environment, and install shell bootstrap wrappers for seamless activation in your favorite shell.
Features
- Auto-detects and activates Python virtual environments in your project.
- Supports multiple shells: bash, zsh, sh, fish, powershell, pwsh, nushell, cmd, csh/tcsh/cshell.
- Installs a shell bootstrap function for one-command activation.
- Flexible CLI flags for advanced usage.
Supported Shells
- bash (full auto-activation and deactivation)
- zsh (full auto-activation and deactivation)
- sh (full auto-activation and deactivation)
- fish (full auto-activation and deactivation)
- powershell, pwsh (full auto-activation, manual deactivation)
- cmd, batch, bat (prints command for manual activation and deactivation)
- nushell, nu (prints command for manual activation and deactivation)
- csh, tcsh, cshell (prints command for manual activation and deactivation)
For detailed shell support and limitations, see docs/user_guide.md.
Installation
Recommended: Install with pipx for isolated environments:
pipx install envon
Alternative: Install with pip (may fail on some distros like Ubuntu or Windows due to PEP 668):
python3 -m pip install envon
After installation, run:
envon --install
This detects your shell and sets up the bootstrap for auto-activation.
For more detailed installation instructions, see docs/installation.md.
Usage
After installation and bootstrap setup, run:
envon
This will activate the nearest virtual environment in your project.
Supported flags: --emit [SHELL], --print-path, --install [SHELL].
For advanced usage, examples, and all flags, see docs/user_guide.md.
Development
For development setup, building, and project structure, see docs/development.md.
Contributor Note
envon is in its early phase. Basic functionality is solid, but we welcome help!
- TCSH/cshell and Nushell support need improvement (auto-activation, overlays).
- If you find issues, please raise an issue.
- If you'd like to contribute, fork and submit a PR—contributions are very welcome!
Let's make envon the best Python venv activator for every shell!
Release Notes
Version 0.1.4
This is one of the initial releases of envon. A lot of work is still ongoing, especially in the testing, CI, and adding support for missing shells (e.g., full auto-activation for Nushell and csh/tcsh).
If you see any issues, feel free to open an issue. If you're interested in contributing, feel free to submit a PR. If you have ideas or anything regarding the project, feel free to open a discussion or feature request in an issue.
Check out the project on PyPI.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file envon-0.1.4.tar.gz.
File metadata
- Download URL: envon-0.1.4.tar.gz
- Upload date:
- Size: 17.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1dfc48c273da2dc6c776600e251bada03b89fd55c4c57db238552fe78fbe7beb
|
|
| MD5 |
c100ba18d43e3a05e797124061fcd95f
|
|
| BLAKE2b-256 |
50d61d571392c8c615718a8a2e245dda0c904c46942f3ee68e6de3b17fde6fe5
|
File details
Details for the file envon-0.1.4-py3-none-any.whl.
File metadata
- Download URL: envon-0.1.4-py3-none-any.whl
- Upload date:
- Size: 16.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f3e79e3b2a1761de8b918d271397a7bcb5558e8745a2f6e33075ecfc10e68f4b
|
|
| MD5 |
00c58df2247b9760a1cd80ba9ee0d289
|
|
| BLAKE2b-256 |
aceb692e1243ff230655daf628f5b2712a30fc6c8ee0ffa28f7310f99f5de9b8
|