https://github.com/vchrombie/peodd
poetry export, but only for dev-dependencies
https://github.com/vchrombie/peodd
dev-dependencies hacktoberfest poetry
Last synced: about 1 year ago
JSON representation
poetry export, but only for dev-dependencies
- Host: GitHub
- URL: https://github.com/vchrombie/peodd
- Owner: vchrombie
- License: gpl-3.0
- Created: 2021-07-07T19:46:56.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-22T17:30:48.000Z (about 3 years ago)
- Last Synced: 2024-10-17T21:31:01.909Z (over 1 year ago)
- Topics: dev-dependencies, hacktoberfest, poetry
- Language: Python
- Homepage: https://pypi.org/project/peodd/
- Size: 52.7 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# peodd
[](https://github.com/vchrombie/peodd/actions/workflows/tests.yml)
[](https://coveralls.io/github/vchrombie/peodd?branch=master)
[](https://badge.fury.io/py/peodd)
[](https://pepy.tech/project/peodd)
[](https://pepy.tech/project/peodd)
poetry export, but only for dev-dependencies
Script to export the pyproject.toml dev-dependencies to a txt file.
This software is licensed under GPL3 or later.
**Note:** Right now, this tool supports only some poetry formats of the dependencies (see below)
- `foo = "^1.2.3"`
- `bar = ">=1.2.3"`
- `bas = {extras = ["bar"], version = "^1.2.3"}`
- `baz = "1.2.3"`
I would be interested to add support for more formats, please
[open an issue](https://github.com/vchrombie/peodd/issues/new) incase if you need any other.
## Requirements
* Python >= 3.6
* Poetry >= 1.0
* tomli >= 1.0.4
* Click >= 7.0.0
* release-tools >= 0.3.0
## Installation
### PyPI
You can install the package directly using pip.
```
$ pip install peodd
```
### Getting the source code
Clone the repository
```
$ git clone https://github.com/vchrombie/peodd/
$ cd peodd/
```
### Prerequisites
#### Poetry
We use [Poetry](https://python-poetry.org/docs/) for managing the project.
You can install it following [these steps](https://python-poetry.org/docs/#installation).
We use [Bitergia/release-tools](https://github.com/Bitergia/release-tools) for managing
the releases. This is also used in the project, so you need not install it again.
### Installation
Install the required dependencies (this will also create a virtual environment)
```
$ poetry install
```
Activate the virtual environment
```
$ poetry shell
```
## Usage
Once you install the tool, you can use it with the `peodd` command.
```
$ peodd --help
Usage: peodd [OPTIONS]
Script to export the pyproject.toml dev-dependencies to a txt file.
Options:
-o, --output TEXT Output filename for the dependencies [required]
--non-dev Export non-dev dependencies [default: False]
--help Show this message and exit.
```
Export the dev-dependencies to `requirements-dev.txt` file
```
$ peodd -o requirements-dev.txt
```
Export the non-dev dependencies to `requirements.txt` file
```
$ peodd --non-dev -o requirements.txt
```
## Contributions
All contributions are welcome. Please feel free to open an issue or a PR.
If you are opening any PR for the code, please be sure to add a
[changelog](https://github.com/Bitergia/release-tools#changelog) entry.
## License
Licensed under GNU General Public License (GPL), version 3 or later.