autopub 1.0.0a45__py3-none-any.whl → 1.0.0a47__py3-none-any.whl

autopub/__init__.py

@@ -41,8 +41,8 @@ class Autopub:
     RELEASE_FILE_PATH = "RELEASE.md"
     plugins: list[AutopubPlugin]
 
-    def __init__(self) -> None:
-        self.plugins = []
+    def __init__(self, plugins: list[type[AutopubPlugin]] | None = None) -> None:
+        self.plugins = [plugin() for plugin in plugins or []]
 
     @cached_property
     def config(self) -> ConfigType:
@@ -86,7 +86,6 @@ class Autopub:
         return ReleaseInfo.from_dict(release_info)
 
     def load_plugins(self, default_plugins: list[str] | None = None) -> None:
-        print("🦆 loading plugins")
         default_plugins = default_plugins or []
 
         additional_plugins: list[str] = self.config.get("plugins", [])  # type: ignore
@@ -94,7 +93,6 @@ class Autopub:
         all_plugins = default_plugins + additional_plugins
 
         plugins = load_plugins(all_plugins)
-        print("plugins", plugins)
 
         self.plugins += [plugin_class() for plugin_class in plugins]
 
@@ -104,7 +102,7 @@ class Autopub:
         if not release_file.exists():
             for plugin in self.plugins:
                 plugin.on_release_file_not_found()
-                
+
             raise ReleaseFileNotFound()
 
         try:
@@ -116,7 +114,7 @@ class Autopub:
 
         for plugin in self.plugins:
             plugin.post_check(release_info)
-        
+
         for plugin in self.plugins:
             plugin.on_release_notes_valid(release_info)
 

autopub/cli/__init__.py

@@ -1,4 +1,4 @@
-from typing import Optional, TypedDict
+from typing import Annotated, Optional, TypedDict
 
 import rich
 import typer
@@ -6,7 +6,6 @@ from rich.console import Group, RenderableType
 from rich.markdown import Markdown
 from rich.padding import Padding
 from rich.panel import Panel
-from typing_extensions import Annotated
 
 from autopub import Autopub
 from autopub.exceptions import AutopubException, InvalidConfiguration
@@ -116,8 +115,7 @@ def main(
         raise typer.Exit()
 
     autopub = Autopub()
-    
-    
+
     # default plugins we always want to load (?)
     autopub.load_plugins(["git", "update_changelog", "bump_version"])
 

autopub/exceptions.py

@@ -4,8 +4,8 @@ from pydantic import ValidationError
 class AutopubException(Exception):
     message: str
 
-    def __init__(self) -> None:
-        super().__init__(self.message)
+    def __init__(self, message: str | None = None) -> None:
+        super().__init__(message or self.message)
 
 
 class ReleaseFileNotFound(AutopubException):

autopub/plugin_loader.py

@@ -1,3 +1,4 @@
+# TODO: use this instead: https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/
 from __future__ import annotations
 
 import os

autopub/plugins/__init__.py

@@ -27,7 +27,7 @@ class AutopubPlugin:
         if configuration_class is None:
             return
 
-        plugin_config = config.get(self.id, {})
+        plugin_config = config.get("plugin_config", {}).get(self.id, {})
 
         self._config = configuration_class.model_validate(plugin_config)
 

autopub/plugins/bump_version.py

@@ -38,8 +38,6 @@ class BumpVersionPlugin(AutopubPlugin):
         release_info.previous_version = str(version)
         release_info.version = version.bump(bump_type).serialize()
 
-        print("👊 bumped version to", release_info.version)
-
     def post_prepare(self, release_info: ReleaseInfo) -> None:
         config = self.pyproject_config
 

autopub/plugins/git.py

@@ -19,13 +19,13 @@ class GitPlugin(AutopubPlugin):
 
         commit_message = textwrap.dedent(
             f"""
-            Release {release_info.version}
+            🤖 Release {release_info.version}
 
             {release_info.release_notes}
 
             [skip ci]
             """
-        )
+        ).strip()
 
         # TODO: config?
         self.run_command(["git", "rm", "RELEASE.md"])

autopub/plugins/github.py

@@ -31,7 +31,9 @@ class GithubConfig(BaseModel):
         """
         Thanks for adding the `RELEASE.md` file!
 
-        Here's a preview of the changelog:
+        Below is the changelog that will be used for the release.
+
+        ---
 
         {changelog}
         """,
@@ -43,7 +45,9 @@ class GithubConfig(BaseModel):
 
         Here's the error:
 
+        ```text
         {error}
+        ```
         """,
     )
 
@@ -142,11 +146,6 @@ class GithubPlugin(AutopubPlugin):
         self, text: str, marker: str = "<!-- autopub-comment -->"
     ) -> None:
         """Update or create a comment on the current PR with the given text."""
-        print(
-            f"Updating or creating comment on PR {self.pull_request} in {self.repository}"
-        )
-
-        # Look for existing autopub comment
         comment_body = f"{marker}\n{text}"
 
         # Search for existing comment
@@ -323,13 +322,12 @@ class GithubPlugin(AutopubPlugin):
         return pr_contributors
 
     def on_release_notes_valid(self, release_info: ReleaseInfo) -> None:
-        print(self.config)
         assert self.pull_request is not None
 
         changelog = self._get_release_message(release_info)
 
         message = self.config.comment_template_success.format(
-            changelog=changelog
+            changelog=changelog.strip()
         )
 
         self._update_or_create_comment(message)
@@ -347,7 +345,7 @@ class GithubPlugin(AutopubPlugin):
     def _get_release_message(
         self,
         release_info: ReleaseInfo,
-        include_release_info: bool = False,
+        include_release_info: bool = True,
         discussion_url: Optional[str] = None,
     ) -> str:
         assert self.pull_request is not None
@@ -355,8 +353,6 @@ class GithubPlugin(AutopubPlugin):
         contributors = self._get_pr_contributors()
         message = textwrap.dedent(
             f"""
-            ## {release_info.version}
-
             {release_info.release_notes}
             """
         )
@@ -364,7 +360,7 @@ class GithubPlugin(AutopubPlugin):
         if not include_release_info:
             return message
 
-        message += f"This release was contributed by @{contributors['pr_author']} in #{self.pull_request.number}"
+        message += f"\nThis release was contributed by @{contributors['pr_author']} in #{self.pull_request.number}"
 
         if contributors["additional_contributors"]:
             additional_contributors = [

autopub-1.0.0a47.dist-info/METADATA

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: autopub
+Version: 1.0.0a47
+Summary: Automatic package release upon pull request merge
+Project-URL: Source, https://github.com/autopub/autopub
+Project-URL: Issues, https://github.com/autopub/autopub/issues
+Author-email: Justin Mayer <entroP@gmail.com>, Patrick Arminio <patrick.arminio@gmail.com>
+License-Expression: AGPL-3.0
+License-File: LICENSE
+Keywords: automatic,packaging,publish,release,version
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Software Distribution
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: <4.0,>=3.9.0
+Requires-Dist: dunamai>=1.23.0
+Requires-Dist: pydantic>=2.10.5
+Requires-Dist: pygithub>=2.5.0
+Requires-Dist: python-frontmatter>=1.1.0
+Requires-Dist: rich>=13.9.4
+Requires-Dist: tomlkit>=0.13.2
+Requires-Dist: typer>=0.15.1
+Description-Content-Type: text/markdown
+
+# AutoPub
+
+[![Build Status](https://img.shields.io/circleci/build/github/autopub/autopub)](https://circleci.com/gh/autopub/autopub) [![PyPI Version](https://img.shields.io/pypi/v/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/

autopub-1.0.0a47.dist-info/RECORD

@@ -0,0 +1,19 @@
+autopub/__init__.py,sha256=IJquq8slI255qvTRiueUnF3cLYxHMWG30wRifMALAww,7253
+autopub/exceptions.py,sha256=Drp6MDlx4cHtqzfAS7IcauRhmSaXnShXgSU7EuevIDM,1573
+autopub/plugin_loader.py,sha256=wYJ3vVQXylTJ76oN7f36mxx_a37KMmxvR_mOxaX2u-0,1915
+autopub/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+autopub/types.py,sha256=gY1WR93XZVFS7vf5JMSmL_h5z7zO51-rtmZ6MYsh3so,1043
+autopub/cli/__init__.py,sha256=opMVjzQKz1NnR00eCrYuSr9vuAAOfgxrsfobgnfOukc,3832
+autopub/plugins/__init__.py,sha256=aJ-i7Q7j4uD_e5ifiAvcAsc9rywmCyGuLhdRqd9cafY,2289
+autopub/plugins/bump_version.py,sha256=-tTGQR0v8K3Bto1Y8UcmkEs4WnExeF1QyHKHPUKgll8,1565
+autopub/plugins/git.py,sha256=-4Fq_N_GJHctrXJMQ8xteEebSgdMrnVCunJiyytnOOw,1067
+autopub/plugins/github.py,sha256=oQwWJUE2oUTQ-U615kbZ1Ce56Tp4JyxP3wbFlGT8D5Q,13645
+autopub/plugins/pdm.py,sha256=Pczye06fKg8_HMJDkEfMXQyvao9rZ7sqzTHFd6lLEpU,532
+autopub/plugins/poetry.py,sha256=d2LvW9RI7ZB3reBOXbcp1mqWmzQ06Uyg_T-MxTvlSBg,517
+autopub/plugins/update_changelog.py,sha256=g_6flOP5wocZbjOaYSayWxobL3ld8f0wT78nFtAIkFc,1586
+autopub/plugins/uv.py,sha256=goo8QxaD3FVJ1c3xOSmN1hikZTCUXN8jWNac1S5uDDY,1089
+autopub-1.0.0a47.dist-info/METADATA,sha256=eCsRRaQRTnFfTuJnTVbVR2i0Jwo4ghyzgQD0UO-SILw,3200
+autopub-1.0.0a47.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+autopub-1.0.0a47.dist-info/entry_points.txt,sha256=IRCGh_RE5fjYT7A0oM6qh0aGLdTjZqJWaRRhbYSaxh8,44
+autopub-1.0.0a47.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+autopub-1.0.0a47.dist-info/RECORD,,

{autopub-1.0.0a45.dist-info → autopub-1.0.0a47.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.1
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

autopub-1.0.0a47.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+autopub = autopub.cli:app

autopub-1.0.0a45.dist-info/METADATA

@@ -1,24 +0,0 @@
-Metadata-Version: 2.1
-Name: autopub
-Version: 1.0.0a45
-Summary: Automatic package release upon pull request merge
-Home-page: https://github.com/autopub/autopub
-Author: Justin Mayer
-Author-email: entroP@gmail.com
-Requires-Python: >=3.9.0,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Provides-Extra: github
-Requires-Dist: dunamai (>=1.23.0,<2.0.0)
-Requires-Dist: pydantic (>=2.10.5,<3.0.0)
-Requires-Dist: pygithub (>=2.5.0,<3.0.0)
-Requires-Dist: python-frontmatter (>=1.1.0,<2.0.0)
-Requires-Dist: rich (>=13.9.4,<14.0.0)
-Requires-Dist: tomlkit (>=0.13.2,<0.14.0)
-Requires-Dist: typer (>=0.15.1,<0.16.0)
-Project-URL: Issue Tracker, https://github.com/autopub/autopub/issues
-Project-URL: Repository, https://github.com/autopub/autopub

autopub-1.0.0a45.dist-info/RECORD

@@ -1,19 +0,0 @@
-autopub/__init__.py,sha256=JOFsdJMarqnRydwUibnWL8JlmijG66I340q4zdcRENs,7263
-autopub/cli/__init__.py,sha256=pIfIQaRPM8GZ1ANIWqWBZrRmaGjRGz-HiCUlPO0_q0I,3870
-autopub/exceptions.py,sha256=gNUbiG3_fVmNjhk2kyueQHPSifNgQf0Bl6IDNvkVhxQ,1534
-autopub/plugin_loader.py,sha256=2ysITgpHGUmcb1mP1Qvs-iBX2wZxmfP9obnebThwUMA,1809
-autopub/plugins/__init__.py,sha256=vpmk0u8nu_ex8eoEtpXJe-gpqww4OnMQaIfSDGx2XDw,2264
-autopub/plugins/bump_version.py,sha256=yOXhKHAGFb1DcmeBdh5RfwkOpEYeTqMlE69HgIyUB58,1628
-autopub/plugins/git.py,sha256=d0SMLc6hwuk0eymj8aHyu3_cEd-7x4fhkwu35wPPV4k,1054
-autopub/plugins/github.py,sha256=872I9Lm5eIORKtOSP5jpxMFqV7b4OBZ2yDoun0XflJ4,13799
-autopub/plugins/pdm.py,sha256=Pczye06fKg8_HMJDkEfMXQyvao9rZ7sqzTHFd6lLEpU,532
-autopub/plugins/poetry.py,sha256=d2LvW9RI7ZB3reBOXbcp1mqWmzQ06Uyg_T-MxTvlSBg,517
-autopub/plugins/update_changelog.py,sha256=g_6flOP5wocZbjOaYSayWxobL3ld8f0wT78nFtAIkFc,1586
-autopub/plugins/uv.py,sha256=goo8QxaD3FVJ1c3xOSmN1hikZTCUXN8jWNac1S5uDDY,1089
-autopub/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-autopub/types.py,sha256=gY1WR93XZVFS7vf5JMSmL_h5z7zO51-rtmZ6MYsh3so,1043
-autopub-1.0.0a45.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-autopub-1.0.0a45.dist-info/METADATA,sha256=p_CKTUpR11QpiGPOuBTshempKityDHTw-ydzsomyi4E,992
-autopub-1.0.0a45.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-autopub-1.0.0a45.dist-info/entry_points.txt,sha256=oeTav5NgCxif6mcZ_HeVGgGv5LzS4DwdI01nr4bO1IM,43
-autopub-1.0.0a45.dist-info/RECORD,,

autopub-1.0.0a45.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-autopub=autopub.cli:app
-