Skip to main content

Automatically add and delete modules to requirements.txt installing them using pip.

Project description

to-requirements.txt | Automatically Update requirements.txt

PyPI Release Build Status Maintainability License

to-requirements.txt allows for the automatic management of dependencies in requirements.txt using pip as a package manager.

Demo

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

to_requirements_txt-2.0.9.tar.gz (21.9 kB view hashes)

Uploaded Source

Built Distribution

to_requirements.txt-2.0.9-py3-none-any.whl (36.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page