# to-requirements.txt | Automatically update requirements.txt
[](https://pypi.org/project/to-requirements.txt/)
[](https://github.com/VoIlAlex/requirements-txt/actions/workflows/publish-to-pypi.yml/badge.svg)
[](https://img.shields.io/maintenance/yes/2023)
[](https://github.com/VoIlAlex/requirements-txt/blob/master/LICENSE.md)
[//]: # ([](https://pepy.tech/project/appdata))
[//]: # ([](https://svgshare.com/i/Zhy.svg))
[//]: # ([](https://svgshare.com/i/ZhY.svg))
[//]: # ([](https://svgshare.com/i/ZjP.svg))
**to-requirements.txt** allows to automatically manage dependencies in requirements.txt using **pip** as a package manager.
[](https://media.giphy.com/media/y9dUiCm2SwaU8qR0eD/giphy.gif)
## Benefits
**Easy to setup.**
The installation process include only two steps: install the package using pip
and setup up it using script provided by the package. That's it.
**Setup in one command.**
You can set up VirtualEnv-based project in one command. It will create virtual environment.
And install *to-requirements.txt* automatically.
**Customizable.**
Customize it the way you like: use it only in git repositories, allow or disallow
automated requirements.txt file creation, enable or disable the package itself.
**Easy to use.**
After installing the package, running setup command and (optionally) customizing it
the package is ready. There is no additional conditions to use. Just install,
uninstall or upgrade packages using *pip* as you usually do.
**Always in sync.**
With *to-requirements.txt* the project's requirements.txt will always stay in sync
with packages that you install using *pip*.
## Installation
To install the package run the following command:
```shell
pip install to-requirements.txt
```
And after that run the command below to initialize the package:
```shell
requirements-txt install
```
It will update your current *pip* scripts to execute the functionality of
this package. Also, if you want to enable all the available functionality of
the package you should put the lines below to your .bashrc, .zshrc or other
.*rc file:
```shell
alias rt=". rt"
alias requirements-txt=". requirements-txt"
```
Or simply use the cli command:
```shell
rt alias
```
It will enable sourced mode of the cli execution and the cli will be able
to activate your virtual environment / deactivate it if required.
*The changes made to **pip** scripts will not affect ordinary *pip* workflow after
uninstalling **to-requirements.txt**.*
### Setup project
To set up VirtualEnv based project just type:
```shell
requirements-txt init
```
The same effect could be achieved much easier with aliases:
```shell
rt i
```
## Documentation
The detailed documentation is available on
[requirements-txt.readthedocs.io](https://requirements-txt.readthedocs.io/en/latest/index.html).
## Contributing
Visit the file [CONTRIBUTING.md](CONTRIBUTING.md).
## License
Visit the file [MIT](LICENSE.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/VoIlAlex/requirements-txt",
"name": "to-requirements.txt",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pip,requirements.txt,dependency,dependencies,requirements,packages,wrapper,repository",
"author": "Ilya Vouk",
"author_email": "ilya.vouk@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/40/28/bd65454b088e5f315abd49feb68121a8bc1b42d2065bb9c07accda832d3a/to-requirements.txt-2.0.8.tar.gz",
"platform": null,
"description": "# to-requirements.txt | Automatically update requirements.txt \n\n[](https://pypi.org/project/to-requirements.txt/)\n[](https://github.com/VoIlAlex/requirements-txt/actions/workflows/publish-to-pypi.yml/badge.svg)\n[](https://img.shields.io/maintenance/yes/2023)\n[](https://github.com/VoIlAlex/requirements-txt/blob/master/LICENSE.md)\n\n[//]: # ([](https://pepy.tech/project/appdata))\n\n[//]: # ([](https://svgshare.com/i/Zhy.svg))\n\n[//]: # ([](https://svgshare.com/i/ZhY.svg))\n\n[//]: # ([](https://svgshare.com/i/ZjP.svg))\n\n**to-requirements.txt** allows to automatically manage dependencies in requirements.txt using **pip** as a package manager.\n\n\n[](https://media.giphy.com/media/y9dUiCm2SwaU8qR0eD/giphy.gif)\n\n\n## Benefits\n\n**Easy to setup.**\nThe installation process include only two steps: install the package using pip\nand setup up it using script provided by the package. That's it.\n\n**Setup in one command.**\nYou can set up VirtualEnv-based project in one command. It will create virtual environment.\nAnd install *to-requirements.txt* automatically.\n\n**Customizable.**\nCustomize it the way you like: use it only in git repositories, allow or disallow\nautomated requirements.txt file creation, enable or disable the package itself.\n\n**Easy to use.**\nAfter installing the package, running setup command and (optionally) customizing it\nthe package is ready. There is no additional conditions to use. Just install,\nuninstall or upgrade packages using *pip* as you usually do.\n\n**Always in sync.**\nWith *to-requirements.txt* the project's requirements.txt will always stay in sync\nwith packages that you install using *pip*.\n\n\n## Installation\n\n\nTo install the package run the following command:\n\n```shell\npip install to-requirements.txt\n```\n \n\nAnd after that run the command below to initialize the package:\n\n```shell\nrequirements-txt install\n```\n\nIt will update your current *pip* scripts to execute the functionality of\nthis package. Also, if you want to enable all the available functionality of\nthe package you should put the lines below to your .bashrc, .zshrc or other \n.*rc file:\n\n```shell\nalias rt=\". rt\"\nalias requirements-txt=\". requirements-txt\"\n```\n\nOr simply use the cli command:\n\n```shell\nrt alias\n```\n\nIt will enable sourced mode of the cli execution and the cli will be able \nto activate your virtual environment / deactivate it if required.\n\n*The changes made to **pip** scripts will not affect ordinary *pip* workflow after\nuninstalling **to-requirements.txt**.*\n\n### Setup project\n\nTo set up VirtualEnv based project just type:\n```shell\nrequirements-txt init\n```\n\nThe same effect could be achieved much easier with aliases:\n```shell\nrt i\n```\n\n## Documentation\n\nThe detailed documentation is available on\n[requirements-txt.readthedocs.io](https://requirements-txt.readthedocs.io/en/latest/index.html).\n\n## Contributing\n\nVisit the file [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## License\n\nVisit the file [MIT](LICENSE.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Automatically add and delete modules to requirements.txt installing them using pip.",
"version": "2.0.8",
"project_urls": {
"Download": "https://github.com/VoIlAlex/requirements-txt/archive/refs/tags/v1.1.10.zip",
"Homepage": "https://github.com/VoIlAlex/requirements-txt"
},
"split_keywords": [
"pip",
"requirements.txt",
"dependency",
"dependencies",
"requirements",
"packages",
"wrapper",
"repository"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27d90f9d05dd278c6319c3f1c5140278d8e85abf3c8dbab9f3c1126e2c90ad4c",
"md5": "019ffafa8b6aa17f36d21b4d584d52a8",
"sha256": "df5078e2d7e886951353cc32d9282609e707357a65f794212f7fc9b968e15f0d"
},
"downloads": -1,
"filename": "to_requirements.txt-2.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "019ffafa8b6aa17f36d21b4d584d52a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 36679,
"upload_time": "2024-02-21T14:24:31",
"upload_time_iso_8601": "2024-02-21T14:24:31.146891Z",
"url": "https://files.pythonhosted.org/packages/27/d9/0f9d05dd278c6319c3f1c5140278d8e85abf3c8dbab9f3c1126e2c90ad4c/to_requirements.txt-2.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4028bd65454b088e5f315abd49feb68121a8bc1b42d2065bb9c07accda832d3a",
"md5": "06fdc630ae56d1f5fc4099c4d542deda",
"sha256": "4e3330af707546df4195e8bf013e08924ec62c565eb92004c13d6869117bb600"
},
"downloads": -1,
"filename": "to-requirements.txt-2.0.8.tar.gz",
"has_sig": false,
"md5_digest": "06fdc630ae56d1f5fc4099c4d542deda",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22362,
"upload_time": "2024-02-21T14:24:32",
"upload_time_iso_8601": "2024-02-21T14:24:32.682405Z",
"url": "https://files.pythonhosted.org/packages/40/28/bd65454b088e5f315abd49feb68121a8bc1b42d2065bb9c07accda832d3a/to-requirements.txt-2.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 14:24:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VoIlAlex",
"github_project": "requirements-txt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "to-requirements.txt"
}
JSON
