Usage
In this section you can find docs on how to use requirements-txt command line tool.
Basic usage
There are two ways to use requirements-txt command line tool. The first one is:
requirements-txt <command> <options>
The second one is to use alias:
rt <command> <options>
Both commands results in the same outcome. It’s just an alias.
Alias
To activate full potential of the cli you should add following lines to your .bashrc, .zshrc or other .*rc file:
alias rt=". rt"
alias requirements-txt=". requirements-txt"
It will allow requirements-txt cli to activate your environment and init command. You can also achieve this by the command:
rt alias
This command will work for the following shells:
bash
zsh
Init
If you want to initialize virtual environment for your project use:
rt init
Or with alias:
rt i
This command will:
Install virtualenv package with your pip or skip this step if it’s already installed.
Create requirements.txt file or skip this step if it already exists.
Install dependencies from your requirements.txt.
Install to-requirements.txt to your newly created environment.
Setup installed to-requirements.txt.
After that you can source your environment with
source venv/bin/activate
and start working on the project.
Install
To override your pip scripts and enable requirements.txt synchronization use:
rt install
This command is not required if use set up your environment with init command.
Help
To get more information about commands use the following command:
rt --help
Config
To use configuration util:
rt config <configuration options>
Show
If you want to see contents of your requirements.txt file type this:
rt show
Or with alias:
rt s