# Rooster
**This interface provided by this tool is unstable, we highly recommend pinning your version.**
## Usage
### Prepare a new release
Prepares a new release, which:
- Determines a new version number
- Generates a changelog entry for the release and adds to `CHANGELOG.md`
- Updates the version number in `pyproject.toml`
```
rooster release [<path>] [--bump major|minor|patch]
```
### Generate a changelog entry for a release
Generates a changelog entry for the current or given version
```
rooster changelog [<path>] [--version <version>]
```
### Generate the contributor list for a release
Generates a contributor list for the current or given version
```
rooster contributors [<path>] [--verison <version>]
```
### Caching
Rooster caches responses from the GitHub GraphQL API in `$PWD/.cache`. You may disable this behavior with `ROOSTER_NO_CACHE=1`.
Raw data
{
"_id": null,
"home_page": "https://github.com/zanieb/rooster",
"name": "rooster-blue",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Zanie",
"author_email": "contact@zanie.dev",
"download_url": "https://files.pythonhosted.org/packages/d6/86/e14955f7f3ca3f86ca3ab0878b3efa746177e1db070874e5b87c040109d6/rooster_blue-0.0.6.tar.gz",
"platform": null,
"description": "# Rooster\n\n**This interface provided by this tool is unstable, we highly recommend pinning your version.**\n\n## Usage\n\n### Prepare a new release\n\nPrepares a new release, which:\n\n- Determines a new version number\n- Generates a changelog entry for the release and adds to `CHANGELOG.md`\n- Updates the version number in `pyproject.toml`\n\n```\nrooster release [<path>] [--bump major|minor|patch]\n```\n\n### Generate a changelog entry for a release\n\nGenerates a changelog entry for the current or given version\n\n```\nrooster changelog [<path>] [--version <version>]\n```\n\n### Generate the contributor list for a release\n\nGenerates a contributor list for the current or given version\n\n```\nrooster contributors [<path>] [--verison <version>]\n```\n\n### Caching\n\nRooster caches responses from the GitHub GraphQL API in `$PWD/.cache`. You may disable this behavior with `ROOSTER_NO_CACHE=1`.\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.0.6",
"project_urls": {
"Homepage": "https://github.com/zanieb/rooster",
"Repository": "https://github.com/zanieb/rooster"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba4e6ff7c57031b7b6f37c8c8b5386e128762f1c4a2fc38b48682afffd6651d5",
"md5": "3e8c3ec31182ad05523e4016805c9794",
"sha256": "10f619919c6f8747f817b8fdb7a90e1d995005ccbb45d3e10abb745d41baf8e8"
},
"downloads": -1,
"filename": "rooster_blue-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e8c3ec31182ad05523e4016805c9794",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 17266,
"upload_time": "2024-06-11T20:37:16",
"upload_time_iso_8601": "2024-06-11T20:37:16.837694Z",
"url": "https://files.pythonhosted.org/packages/ba/4e/6ff7c57031b7b6f37c8c8b5386e128762f1c4a2fc38b48682afffd6651d5/rooster_blue-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d686e14955f7f3ca3f86ca3ab0878b3efa746177e1db070874e5b87c040109d6",
"md5": "f62c47ef605e81e86b37da3b401e8069",
"sha256": "5c0cf8b4cc6a393c7bc34f2c30db44faa291c19b2c706d59cc22191b5e3792b9"
},
"downloads": -1,
"filename": "rooster_blue-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "f62c47ef605e81e86b37da3b401e8069",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 14462,
"upload_time": "2024-06-11T20:37:17",
"upload_time_iso_8601": "2024-06-11T20:37:17.819920Z",
"url": "https://files.pythonhosted.org/packages/d6/86/e14955f7f3ca3f86ca3ab0878b3efa746177e1db070874e5b87c040109d6/rooster_blue-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-11 20:37:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zanieb",
"github_project": "rooster",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rooster-blue"
}