Automatically add and delete modules to requirements.txt installing them using pip.
Project description
to-requirements.txt | Automatically Update requirements.txt
to-requirements.txt allows for the automatic management of dependencies in requirements.txt
using pip as a package manager.
Benefits
-
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.
Installation
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.
Setup Project
To set up a VirtualEnv-based project, simply type:
requirements-txt init
Or, achieve the same effect more easily with aliases:
rt i
Documentation
For detailed documentation, visit requirements-txt.readthedocs.io.
Contributing
See CONTRIBUTING.md for contribution guidelines.
License
This project is licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
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
File details
Details for the file to_requirements_txt-2.0.11.tar.gz
.
File metadata
- Download URL: to_requirements_txt-2.0.11.tar.gz
- Upload date:
- Size: 21.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.19
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e0b2a4917cea931a11b997d8071b56b17a63d04fda50a5bf9b58b6938ac03e1 |
|
MD5 | 4225274649885f029533f0f01463d557 |
|
BLAKE2b-256 | 99d5ef0bfd4a6b784caffe4436f2d745639ed9d7ee9b152b8affef30bc130485 |
File details
Details for the file to_requirements.txt-2.0.11-py3-none-any.whl
.
File metadata
- Download URL: to_requirements.txt-2.0.11-py3-none-any.whl
- Upload date:
- Size: 36.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.19
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9e2ff494b93ee42e7ec19769fffe250315a78e7b5441a219155547beca47f1c |
|
MD5 | 7e6b68d66c0b2067235755d1fdf5dcc3 |
|
BLAKE2b-256 | af07c685f1b4351472a411fffed7468baa22f5f7710749dae440203107d2ac72 |