to-requirements.txt allows for the automatic management of dependencies in requirements.txt
using pip as a package manager.
-
Easy Setup: The installation process involves just two steps: installing the package using pip and setting it up using the provided script. That's it.
-
One-Command Setup: Set up a VirtualEnv-based project in a single command. It creates a virtual environment and installs to-requirements.txt automatically.
-
Customizable: Customize it as you prefer: use it only in Git repositories, allow or disallow automated
requirements.txt
file creation, enable or disable the package itself. -
User-Friendly: After installation and setup, there are no additional conditions to use. Simply install, uninstall, or upgrade packages using pip as usual.
-
Always in Sync: With to-requirements.txt, the project's
requirements.txt
will always stay in sync with packages installed via pip.
To install the package, run the following command:
pip install to-requirements.txt
Then, initialize the package with:
requirements-txt install
To enable all available functionality, add the following lines to your .bashrc
, .zshrc
, or other .*rc
file:
alias rt=". rt"
alias requirements-txt=". requirements-txt"
Or, use the CLI command:
rt alias
This enables sourced mode of the CLI execution and allows the CLI to activate or deactivate your virtual environment if required.
Note: The changes made to pip scripts will not affect the ordinary pip workflow after uninstalling to-requirements.txt.
To set up a VirtualEnv-based project, simply type:
requirements-txt init
Or, achieve the same effect more easily with aliases:
rt i
For detailed documentation, visit requirements-txt.readthedocs.io.
See CONTRIBUTING.md for contribution guidelines.
This project is licensed under the MIT License.