# AutoPub
[](https://circleci.com/gh/autopub/autopub) [](https://pypi.org/project/autopub/)
AutoPub enables project maintainers to release new package versions to PyPI by merging pull requests.
## Environment
AutoPub is intended for use with continuous integration (CI) systems such as [GitHub Actions][], [CircleCI][], or [Travis CI][]. Projects used with AutoPub are built via [build][] and published via [Twine][]. Contributions that add support for other CI and build systems are welcome.
## Configuration
AutoPub settings can be configured via the `[tool.autopub]` table in the target project’s `pyproject.toml` file. Required settings include Git username and email address:
```toml
[tool.autopub]
git-username = "Your Name"
git-email = "your_email@example.com"
```
## Release Files
Contributors should include a `RELEASE.md` file in their pull requests with two bits of information:
* Release type: major, minor, or patch
* Description of the changes, to be used as the changelog entry
Example:
Release type: patch
Add function to update version strings in multiple files.
## Usage
The following `autopub` sub-commands can be used as steps in your CI flows:
* `autopub check`: Check whether release file exists.
* `autopub prepare`: Update version strings and add entry to changelog.
* `autopub build`: Build the project.
* `autopub commit`: Add, commit, and push incremented version and changelog changes.
* `autopub githubrelease`: Create a new release on GitHub.
* `autopub publish`: Publish a new release.
For systems such as Travis CI in which only one deployment step is permitted, there is a single command that runs the above steps in sequence:
* `autopub deploy`: Run `prepare`, `build`, `commit`, `githubrelease`, and `publish` in one invocation.
[GitHub Actions]: https://github.com/features/actions
[CircleCI]: https://circleci.com
[Travis CI]: https://travis-ci.org
[build]: https://pypa-build.readthedocs.io
[Twine]: https://twine.readthedocs.io/
Raw data
{
"_id": null,
"home_page": "https://github.com/autopub/autopub",
"name": "autopub",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "automatic,packaging,publish,release,version",
"author": "Justin Mayer",
"author_email": "entroP@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/19/b4/7d58bf5318021e63dfc1728c7376150425eef38fd1bb87466abde3bf4c55/autopub-0.3.0.tar.gz",
"platform": null,
"description": "# AutoPub\n\n[](https://circleci.com/gh/autopub/autopub) [](https://pypi.org/project/autopub/)\n\nAutoPub enables project maintainers to release new package versions to PyPI by merging pull requests.\n\n## Environment\n\nAutoPub is intended for use with continuous integration (CI) systems such as [GitHub Actions][], [CircleCI][], or [Travis CI][]. Projects used with AutoPub are built via [build][] and published via [Twine][]. Contributions that add support for other CI and build systems are welcome.\n\n## Configuration\n\nAutoPub settings can be configured via the `[tool.autopub]` table in the target project\u2019s `pyproject.toml` file. Required settings include Git username and email address:\n\n```toml\n[tool.autopub]\ngit-username = \"Your Name\"\ngit-email = \"your_email@example.com\"\n```\n\n## Release Files\n\nContributors should include a `RELEASE.md` file in their pull requests with two bits of information:\n\n* Release type: major, minor, or patch\n* Description of the changes, to be used as the changelog entry\n\nExample:\n\n Release type: patch\n\n Add function to update version strings in multiple files.\n\n## Usage\n\nThe following `autopub` sub-commands can be used as steps in your CI flows:\n\n* `autopub check`: Check whether release file exists.\n* `autopub prepare`: Update version strings and add entry to changelog.\n* `autopub build`: Build the project.\n* `autopub commit`: Add, commit, and push incremented version and changelog changes.\n* `autopub githubrelease`: Create a new release on GitHub.\n* `autopub publish`: Publish a new release.\n\nFor systems such as Travis CI in which only one deployment step is permitted, there is a single command that runs the above steps in sequence:\n\n* `autopub deploy`: Run `prepare`, `build`, `commit`, `githubrelease`, and `publish` in one invocation.\n\n\n[GitHub Actions]: https://github.com/features/actions\n[CircleCI]: https://circleci.com\n[Travis CI]: https://travis-ci.org\n[build]: https://pypa-build.readthedocs.io\n[Twine]: https://twine.readthedocs.io/",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Automatic package release upon pull request merge",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/autopub/autopub",
"Issue Tracker": "https://github.com/autopub/autopub/issues",
"Repository": "https://github.com/autopub/autopub"
},
"split_keywords": [
"automatic",
"packaging",
"publish",
"release",
"version"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "11690fb95f977561245c90e45fc7f686f501f044cdfc6ecc69115a137be113f6",
"md5": "a31eb785e1f7158471e080015a24a298",
"sha256": "f2adb15044be3bd26f23c2f96222997ee5923a219a7759fcf1316a249ade48a4"
},
"downloads": -1,
"filename": "autopub-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a31eb785e1f7158471e080015a24a298",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 22328,
"upload_time": "2023-06-07T19:38:44",
"upload_time_iso_8601": "2023-06-07T19:38:44.331316Z",
"url": "https://files.pythonhosted.org/packages/11/69/0fb95f977561245c90e45fc7f686f501f044cdfc6ecc69115a137be113f6/autopub-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "19b47d58bf5318021e63dfc1728c7376150425eef38fd1bb87466abde3bf4c55",
"md5": "cbd54d469455f224f8f50cca08f0305c",
"sha256": "c00fc83d6794947a78babe7d00b91a713ed1ff0307517b4af3b617ff5947f90a"
},
"downloads": -1,
"filename": "autopub-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "cbd54d469455f224f8f50cca08f0305c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 19851,
"upload_time": "2023-06-07T19:38:45",
"upload_time_iso_8601": "2023-06-07T19:38:45.854416Z",
"url": "https://files.pythonhosted.org/packages/19/b4/7d58bf5318021e63dfc1728c7376150425eef38fd1bb87466abde3bf4c55/autopub-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-07 19:38:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "autopub",
"github_project": "autopub",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "autopub"
}
JSON
