Metadata-Version: 2.1
Name: peodd
Version: 0.2.0
Summary: Script to export the pyproject.toml dev-dependencies to a txt file.
Home-page: https://github.com/vchrombie/peodd
License: GPL-3.0+
Author: Venu Vardhan Reddy Tekula
Author-email: venuvardhanreddytekula8@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=7.0,<8.0)
Requires-Dist: release-tools (>=0.3.0,<0.4.0)
Requires-Dist: tomli (>=1.0.4,<2.0.0)
Project-URL: Bug Tracker, https://github.com/vchrombie/peodd/issues
Project-URL: Repository, https://github.com/vchrombie/peodd
Description-Content-Type: text/markdown

# 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 (specifically `foo = '^n.n.n'`, `foo = '>=n.n.n'`, `foo = 'n.n.n'`). 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
 * tomlkit >= 0.5.8
 * 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 file for the dependencies  [default: requirements-
                     dev.txt]

  --help             Show this message and exit.
```

Export the dev-dependencies to `requirements-dev.txt` file
```
$ peodd -o requirements-dev.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.

