Metadata-Version: 2.1
Name: pyproject-version
Version: 0.1.0.dev1
Summary: Utilities for maintaining the version in python projects.
License: MIT
Author: Cory Laughlin
Author-email: laughlin.cory@gmail.com
Requires-Python: >=3.11,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: semver (>=3.0.2,<4.0.0)
Requires-Dist: tomlkit (>=0.12.4,<0.13.0)
Description-Content-Type: text/markdown

# Pyproject Version

A tool to manage the version of your Python project.

(Note: This is a work in progress and currently only supports Poetry based projects.)

## Installation

```bash
pip install pyproject-version
```

## Usage

By default, this tool will only change the version in the `pyproject.toml` file located in the current directory. If you want to change the version in a different directory, use the `--project-root` option.

To sync the version in the `pyproject.toml` file with the version in the `__init__.py` file of the project, add the following to the `pyproject.toml` file:

```toml
[tool.pyproject-version]
files = ["my_project/__init__.py"]
```

### Version Bump

```bash
pyproject-version bump [OPTIONS] {major|minor|patch|prerelease|build}
```

**Options:**

+ `-r`, `--project-root` `DIRECTORY`

    The root of the Python project.
+ `-t`, `--token` `TEXT`

    The token to use for pre-release and build versions.
+ `--dry-run`

    Print the new version without updating.



## License

MIT License, see [LICENSE](LICENSE) for more information.
