pyproject-deplister


Namepyproject-deplister JSON
Version 0.1.2 PyPI version JSON
download
home_pageNone
Summarypyproject-deplister is a Python package for extracting dependency information from pyproject.toml files and converting it into the format of a requirements.txt file. With its simple and intuitive interface, pyproject-deplister makes it easy to manage and track dependencies for your Python projects, ensuring that you have all the necessary packages installed and up-to-date.
upload_time2024-04-17 15:23:15
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT License Copyright (c) 2024 HE-Arc Neuchâtel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords dependencies pyproject.toml extractor list requirements.txt
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
# pyproject-deplister

Python package for extracting dependencies from `pyproject.toml` files and converting them into the format of a `requirements.txt` file.

## Installation

You can install `pyproject-deplister` using pip:

```
pip install pyproject-deplister
```

## Usage

To use `pyproject-deplister`, simply provide the path to your `pyproject.toml` file as an argument:

```
pyproject-deplister -p path/to/pyproject.toml
```

The output will be a list of dependencies in the format of a `requirements.txt` file, which you can use with `pip` to install and manage your project's dependencies.

For example:

```
numpy==1.21.0
pandas==1.3.0
scikit-learn==0.24.2
```

There are also additional options available:
* `-p` or `--path`: Specify the path to the `pyproject.toml` file. By default, the current working directory will be used.
* `-o` or `--output`: Specify the output file for the `requirements.txt` file. By default, the output will be printed to the console.
* `-e` or `--extra`: Include dependencies from the specified extras in the output. For example, `-e dev` will include dependencies from the `dev` extras. You can specify multiple extras separated by space.

```
pyproject-deplister [-h] [--extra [EXTRA ...]] [--path [PATH]] [--output_file [OUTPUT_FILE]]
```

## Features

* Extract dependency information from `pyproject.toml` files
* Convert dependency information into the format of a `requirements.txt` file
* Simple and intuitive interface

## Disclaimer

Dependencies can only be extracted if they follow specifically the specification introduced in [PEP 631](https://peps.python.org/pep-0631/).

## Requirements

* Python 3.6 or higher

## License

`pyproject-deplister` is licensed under the [MIT License](LICENSE).

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pyproject-deplister",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "dependencies, pyproject.toml, extractor, list, requirements.txt",
    "author": null,
    "author_email": "C\u00e9lien Donz\u00e9 <celien.donze@he-arc.ch>, Jonathan Guerne <jonathan.guerne@he-arc.ch>",
    "download_url": "https://files.pythonhosted.org/packages/3d/fe/ef59fd7398f5cc5ef167699b0f0aee528f62094436596096713477e9b2ae/pyproject_deplister-0.1.2.tar.gz",
    "platform": null,
    "description": "\r\n# pyproject-deplister\r\n\r\nPython package for extracting dependencies from `pyproject.toml` files and converting them into the format of a `requirements.txt` file.\r\n\r\n## Installation\r\n\r\nYou can install `pyproject-deplister` using pip:\r\n\r\n```\r\npip install pyproject-deplister\r\n```\r\n\r\n## Usage\r\n\r\nTo use `pyproject-deplister`, simply provide the path to your `pyproject.toml` file as an argument:\r\n\r\n```\r\npyproject-deplister -p path/to/pyproject.toml\r\n```\r\n\r\nThe output will be a list of dependencies in the format of a `requirements.txt` file, which you can use with `pip` to install and manage your project's dependencies.\r\n\r\nFor example:\r\n\r\n```\r\nnumpy==1.21.0\r\npandas==1.3.0\r\nscikit-learn==0.24.2\r\n```\r\n\r\nThere are also additional options available:\r\n* `-p` or `--path`: Specify the path to the `pyproject.toml` file. By default, the current working directory will be used.\r\n* `-o` or `--output`: Specify the output file for the `requirements.txt` file. By default, the output will be printed to the console.\r\n* `-e` or `--extra`: Include dependencies from the specified extras in the output. For example, `-e dev` will include dependencies from the `dev` extras. You can specify multiple extras separated by space.\r\n\r\n```\r\npyproject-deplister [-h] [--extra [EXTRA ...]] [--path [PATH]] [--output_file [OUTPUT_FILE]]\r\n```\r\n\r\n## Features\r\n\r\n* Extract dependency information from `pyproject.toml` files\r\n* Convert dependency information into the format of a `requirements.txt` file\r\n* Simple and intuitive interface\r\n\r\n## Disclaimer\r\n\r\nDependencies can only be extracted if they follow specifically the specification introduced in [PEP 631](https://peps.python.org/pep-0631/).\r\n\r\n## Requirements\r\n\r\n* Python 3.6 or higher\r\n\r\n## License\r\n\r\n`pyproject-deplister` is licensed under the [MIT License](LICENSE).\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 HE-Arc Neuch\u00e2tel  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "pyproject-deplister is a Python package for extracting dependency information from pyproject.toml files and converting it into the format of a requirements.txt file. With its simple and intuitive interface, pyproject-deplister makes it easy to manage and track dependencies for your Python projects, ensuring that you have all the necessary packages installed and up-to-date.",
    "version": "0.1.2",
    "project_urls": null,
    "split_keywords": [
        "dependencies",
        " pyproject.toml",
        " extractor",
        " list",
        " requirements.txt"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b0764010419464b01e5c5ca581ffbfaa7c069ff708f5c519984bb67d5d58242e",
                "md5": "fc76875c6ffef89001f8fe9bc1afa87a",
                "sha256": "d1e5dced4773cde34afb0e3fb13104f3673379654b9a41c78d15b909ea8be606"
            },
            "downloads": -1,
            "filename": "pyproject_deplister-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fc76875c6ffef89001f8fe9bc1afa87a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6017,
            "upload_time": "2024-04-17T15:23:14",
            "upload_time_iso_8601": "2024-04-17T15:23:14.139424Z",
            "url": "https://files.pythonhosted.org/packages/b0/76/4010419464b01e5c5ca581ffbfaa7c069ff708f5c519984bb67d5d58242e/pyproject_deplister-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3dfeef59fd7398f5cc5ef167699b0f0aee528f62094436596096713477e9b2ae",
                "md5": "d89a1e5f85440247d0d90cacc3d77ab6",
                "sha256": "6cf4f7655143fb4e741406afc4edfaf2c66d9e9e23be03806accf0257f01fd9a"
            },
            "downloads": -1,
            "filename": "pyproject_deplister-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "d89a1e5f85440247d0d90cacc3d77ab6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5276,
            "upload_time": "2024-04-17T15:23:15",
            "upload_time_iso_8601": "2024-04-17T15:23:15.340152Z",
            "url": "https://files.pythonhosted.org/packages/3d/fe/ef59fd7398f5cc5ef167699b0f0aee528f62094436596096713477e9b2ae/pyproject_deplister-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-17 15:23:15",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pyproject-deplister"
}
None
Elapsed time: 0.50359s