# 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/b4/5f/1f410ba2f3058e9ea90bdabd5b427a8bae2b217fd17a8e973c075f5f3748/rooster_blue-0.0.8.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.8",
"project_urls": {
"Homepage": "https://github.com/zanieb/rooster",
"Repository": "https://github.com/zanieb/rooster"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d9c679085dbbfae35014f1a41df137d915c22cc632d101ceec939f6873050fd",
"md5": "189dfd24809784bf91df197c50cfafad",
"sha256": "86f2d3783ea11b590dfd9e1c07d4dd7a12c247ae9dc62095460c53b611ee1ec9"
},
"downloads": -1,
"filename": "rooster_blue-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "189dfd24809784bf91df197c50cfafad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 17283,
"upload_time": "2024-08-21T23:49:31",
"upload_time_iso_8601": "2024-08-21T23:49:31.304219Z",
"url": "https://files.pythonhosted.org/packages/2d/9c/679085dbbfae35014f1a41df137d915c22cc632d101ceec939f6873050fd/rooster_blue-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b45f1f410ba2f3058e9ea90bdabd5b427a8bae2b217fd17a8e973c075f5f3748",
"md5": "acd1ef213063433fef62aa5ee11cd7ed",
"sha256": "52b74f5ce12ae8d8304722722ae2c785b8edd8473410dc420da617c6331f72a7"
},
"downloads": -1,
"filename": "rooster_blue-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "acd1ef213063433fef62aa5ee11cd7ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 14452,
"upload_time": "2024-08-21T23:49:32",
"upload_time_iso_8601": "2024-08-21T23:49:32.631263Z",
"url": "https://files.pythonhosted.org/packages/b4/5f/1f410ba2f3058e9ea90bdabd5b427a8bae2b217fd17a8e973c075f5f3748/rooster_blue-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 23:49:32",
"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"
}