# poetry-add-requirements.txt
Add dependencies specified in requirements.txt file(s) to your Poetry project
- [poetry-add-requirements.txt](#poetry-add-requirementstxt)
- [Features](#features)
- [Installation](#installation)
- [pipx](#pipx)
- [pip](#pip)
- [Usage](#usage)
- [Usage examples and tips](#usage-examples-and-tips)
- [Develop](#develop)
## Features
- Auto detect charset of requirements.txt file(s) and feed normalized dependency specs to `poetry`.
- Stop on first `poetry add` error.
- Ignore dependency version requirements specified in requirements.txt file(s).
- Ignore errors when installing individual dependencies.
- Pass arbitrary arguments to `poetry add` after `--` at the end of the command.
## Installation
### pipx
This is the recommended installation method.
```
$ pipx install poetry-add-requirements.txt
```
### [pip](https://pypi.org/project/poetry-add-requirements.txt/)
```
$ pip install poetry-add-requirements.txt
```
## Usage
Run `poetry-add-requirements.txt`, optionally specify your requirements.txt files and `--dev` for dev dependencies.
`poeareq` is provided is an alias to `poetry-add-requirements.txt`.
```
$ poeareq --help
usage: poetry-add-requirements.txt [-h] [-D] [-I] [-i] [-n] [-p ...] [-V]
[requirements.txt file(s) ...]
Add dependencies specified in requirements.txt to your Poetry project
positional arguments:
requirements.txt file(s)
Path(s) to your requirements.txt file(s) (default:
requirements.txt)
options:
-h, --help show this help message and exit
-D, --dev Add to development dependencies (default: False)
-I, --ignore-version-requirements
Ignore dependency version requirements in
requirements.txt file(s) (default: False)
-i, --ignore-errors Ignore errors (default: False)
-n, --dry-run Dry run, do not add dependencies (default: False)
-p ..., --poetry-args ...
Additional arguments to pass to Poetry, put this at
the END of the command (default: None)
-V, --version show program's version number and exit
```
### Usage examples and tips
For examples, see [test-extra-args.sh](./tests/test-extra-args.sh).
Tips:
- Put all req files before any options
- Put `-p`, `--poetry-args` at the end of the command
- Pass `-n`, `--dry-run` to see the poetry commands that would be run
## Develop
```
$ git clone https://github.com/tddschn/poetry-add-requirements.txt.git
$ cd poetry-add-requirements.txt
$ poetry install
```
Raw data
{
"_id": null,
"home_page": "https://github.com/tddschn/poetry-add-requirements.txt",
"name": "poetry-add-requirements.txt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "poetry,requirements.txt",
"author": "Xinyuan Chen",
"author_email": "45612704+tddschn@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/30/84/bf2534071e31d847365bc571ba3430afe44149e571309586f409b353a420/poetry_add_requirements_txt-1.4.0.tar.gz",
"platform": null,
"description": "# poetry-add-requirements.txt\n\nAdd dependencies specified in requirements.txt file(s) to your Poetry project\n\n- [poetry-add-requirements.txt](#poetry-add-requirementstxt)\n - [Features](#features)\n - [Installation](#installation)\n - [pipx](#pipx)\n - [pip](#pip)\n - [Usage](#usage)\n - [Usage examples and tips](#usage-examples-and-tips)\n - [Develop](#develop)\n\n## Features\n\n- Auto detect charset of requirements.txt file(s) and feed normalized dependency specs to `poetry`.\n- Stop on first `poetry add` error.\n- Ignore dependency version requirements specified in requirements.txt file(s).\n- Ignore errors when installing individual dependencies.\n- Pass arbitrary arguments to `poetry add` after `--` at the end of the command.\n\n## Installation\n\n### pipx\n\nThis is the recommended installation method.\n\n```\n$ pipx install poetry-add-requirements.txt\n```\n\n### [pip](https://pypi.org/project/poetry-add-requirements.txt/)\n\n```\n$ pip install poetry-add-requirements.txt\n```\n\n## Usage\n\nRun `poetry-add-requirements.txt`, optionally specify your requirements.txt files and `--dev` for dev dependencies.\n\n`poeareq` is provided is an alias to `poetry-add-requirements.txt`.\n\n```\n$ poeareq --help\n\nusage: poetry-add-requirements.txt [-h] [-D] [-I] [-i] [-n] [-p ...] [-V]\n [requirements.txt file(s) ...]\n\nAdd dependencies specified in requirements.txt to your Poetry project\n\npositional arguments:\n requirements.txt file(s)\n Path(s) to your requirements.txt file(s) (default:\n requirements.txt)\n\noptions:\n -h, --help show this help message and exit\n -D, --dev Add to development dependencies (default: False)\n -I, --ignore-version-requirements\n Ignore dependency version requirements in\n requirements.txt file(s) (default: False)\n -i, --ignore-errors Ignore errors (default: False)\n -n, --dry-run Dry run, do not add dependencies (default: False)\n -p ..., --poetry-args ...\n Additional arguments to pass to Poetry, put this at\n the END of the command (default: None)\n -V, --version show program's version number and exit\n\n```\n\n### Usage examples and tips\n\nFor examples, see [test-extra-args.sh](./tests/test-extra-args.sh).\n\nTips:\n- Put all req files before any options\n- Put `-p`, `--poetry-args` at the end of the command\n- Pass `-n`, `--dry-run` to see the poetry commands that would be run\n\n## Develop\n\n```\n$ git clone https://github.com/tddschn/poetry-add-requirements.txt.git\n$ cd poetry-add-requirements.txt\n$ poetry install\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "Add dependencies specified in requirements.txt file(s) to your Poetry project",
"version": "1.4.0",
"project_urls": {
"Bug Tracker": "https://github.com/tddschn/poetry-add-requirements.txt/issues",
"Homepage": "https://github.com/tddschn/poetry-add-requirements.txt",
"Repository": "https://github.com/tddschn/poetry-add-requirements.txt"
},
"split_keywords": [
"poetry",
"requirements.txt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "adf652b188ca4b27f367d1e777c42db2749d798409b7bbd2adb82df9a0881c04",
"md5": "0c07be1aafcccb125a79b99432f3693f",
"sha256": "2617cc3d94e8b829976eae66d184ba7712ebf53f963ff904352b48a56412fb86"
},
"downloads": -1,
"filename": "poetry_add_requirements_txt-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0c07be1aafcccb125a79b99432f3693f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 5451,
"upload_time": "2024-01-12T21:05:59",
"upload_time_iso_8601": "2024-01-12T21:05:59.459150Z",
"url": "https://files.pythonhosted.org/packages/ad/f6/52b188ca4b27f367d1e777c42db2749d798409b7bbd2adb82df9a0881c04/poetry_add_requirements_txt-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3084bf2534071e31d847365bc571ba3430afe44149e571309586f409b353a420",
"md5": "6724ce406a9e017efa0921d58dcc6eab",
"sha256": "a8ad4525fe80fb60dd27323bcd1e2262e8667e0b27fbc345166f9ac78ae576a6"
},
"downloads": -1,
"filename": "poetry_add_requirements_txt-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "6724ce406a9e017efa0921d58dcc6eab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 4100,
"upload_time": "2024-01-12T21:06:01",
"upload_time_iso_8601": "2024-01-12T21:06:01.193537Z",
"url": "https://files.pythonhosted.org/packages/30/84/bf2534071e31d847365bc571ba3430afe44149e571309586f409b353a420/poetry_add_requirements_txt-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-12 21:06:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tddschn",
"github_project": "poetry-add-requirements.txt",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "poetry-add-requirements.txt"
}
JSON
