Skip to main content

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

Project description

REX | Automatically Update requirements.txt

PyPI Release Build Status Maintainability License

REX 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 rex

To enable all available functionality, add the following lines to your .bashrc, .zshrc, or other .*rc file:

rex alias

or just paste this lines to your .bashrc, .zshrc, or other .*rc file:

alias rt=". rt"
alias requirements-txt=". requirements-txt"
alias rex=". rex"

This enables sourced mode of the CLI execution and allows the CLI to activate or deactivate your virtual environment if required.

Setup Project

To set up a VirtualEnv-based project, simply type:

rex init

Or, achieve the same effect more easily with aliases:

rex i

Note: The changes made to pip scripts will not affect the ordinary pip workflow after uninstalling to-requirements.txt.

Aliases

There are a few aliases available to use instead of rex command:

  • requirements-txt - legacy command.
  • rt - legacy command shortened.

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.14.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

to_requirements_txt-2.0.14-py3-none-any.whl (38.1 kB view details)

Uploaded Python 3

File details

Details for the file to_requirements_txt-2.0.14.tar.gz.

File metadata

  • Download URL: to_requirements_txt-2.0.14.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for to_requirements_txt-2.0.14.tar.gz
Algorithm Hash digest
SHA256 ab25a6ed3f77d015e5612cae618029af82e0b25b79741f1c45bf6031ce3687f8
MD5 704b2aad33a7c54bdbf63298873ddc6c
BLAKE2b-256 1a11b77f0aae4333d21bbcfc0e4b9974cff4470b668ed71e72bbfac9c7a2b969

See more details on using hashes here.

File details

Details for the file to_requirements_txt-2.0.14-py3-none-any.whl.

File metadata

File hashes

Hashes for to_requirements_txt-2.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 97f7489cbe90c6fbf6bc9bdb0af525fe5a57914f13817a21d59e6782486c4a44
MD5 4a4fd426a5eca33b9c71342d1a308f0c
BLAKE2b-256 f56c9fecdb1c995e45f3669499efb3ab2d9f4ccf7907a2e90547ec6d5c79e529

See more details on using hashes here.

Supported by

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