usechange 0.1.7__tar.gz

usechange-0.1.7/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Edward Boswell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

usechange-0.1.7/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.4
+Name: usechange
+Version: 0.1.7
+Summary: Generate Beautiful Changelogs using Conventional Commits
+Author: Edward Boswell
+Author-email: Edward Boswell <thememium@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Requires-Dist: tomli>=2.4.0
+Requires-Dist: usecli>=0.1.32
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/thememium/usechange
+Project-URL: Documentation, https://github.com/thememium/usechange
+Project-URL: Repository, https://github.com/thememium/usechange.git
+Project-URL: Issues, https://github.com/thememium/usechange/issues
+Project-URL: Changelog, https://github.com/thememium/usechange/blob/master/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+<a name="readme-top"></a>
+
+<div align="center">
+  <a href="https://github.com/thememium/usechange">
+    <img src="https://raw.githubusercontent.com/thememium/usechange/refs/heads/master/docs/images/usechange-logo-dark-bg.png" alt="useChange" width="520" height="162">
+  </a>
+
+  <p align="center">
+    <a href="#table-of-contents"><strong>Explore the Documentation »</strong></a>
+    <br />
+    <a href="https://github.com/thememium/usechange/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/thememium/usechange/issues">Request Feature</a>
+  </p>
+</div>
+
+<!-- TABLE OF CONTENTS -->
+
+<a name="table-of-contents"></a>
+
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#about">About</a></li>
+    <li><a href="#quick-start">Quick Start</a></li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#development">Development</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+  </ol>
+</details>
+
+<!-- ABOUT -->
+
+## About
+
+usechange is a Python CLI for generating changelogs and release notes from
+Conventional Commits. It reads git history between refs, groups commits by type,
+renders Markdown release notes, and can update version numbers based on semantic
+versioning rules.
+
+It gives you:
+
+- **Changelog generation** - Render release notes and optionally write to
+  CHANGELOG.md.
+- **Semver bumping** - Determine version bumps from commit types and breaking
+  changes.
+- **Release workflows** - Tag and publish using uv and gh.
+- **GitHub sync** - Sync release notes to GitHub releases.
+- **Repo metadata** - Create commit and compare links automatically.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- QUICK START -->
+
+## Quick Start
+
+### Install usechange with uv (recommended)
+
+```sh
+uv add usechange
+```
+
+### Install with pip (alternative)
+
+```sh
+pip install usechange
+```
+
+### Generate a changelog
+
+```sh
+usechange changelog --write
+```
+
+### Sync the latest release to GitHub
+
+```sh
+usechange github release
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- USAGE -->
+
+## Usage
+
+### Generate changelog
+
+```sh
+usechange changelog --from v0.1.0 --to HEAD --output CHANGELOG.md
+```
+
+### Version bumping
+
+```sh
+usechange changelog --bump --write
+usechange changelog --major --write
+```
+
+### Release workflow
+
+```sh
+usechange release --yes
+```
+
+### GitHub release sync
+
+```sh
+usechange github release 0.2.0
+usechange github release all
+```
+
+### Configuration
+
+usechange reads configuration from one of the following:
+
+- changelog.config.json
+- .changelogrc
+- changelog.config.toml
+- pyproject.toml under [tool.changelog]
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- DEVELOPMENT -->
+
+## Development
+
+Common tasks:
+
+```sh
+uv run poe test
+uv run poe lint
+uv run poe format
+uv run poe typecheck
+uv run poe clean-full
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTRIBUTING -->
+
+## Contributing
+
+Quick workflow:
+
+1. Fork and branch: `git checkout -b feature/name`
+2. Make changes
+3. Run checks: `uv run poe clean-full`
+4. Commit and push
+5. Open a Pull Request
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- LICENSE -->
+
+## License
+
+License not yet specified in this repository.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+---
+
+<div align="center">
+  <p>
+    <sub>Built by <a href="https://github.com/thememium">thememium</a></sub>
+  </p>
+</div>

usechange-0.1.7/README.md

@@ -0,0 +1,169 @@
+<a name="readme-top"></a>
+
+<div align="center">
+  <a href="https://github.com/thememium/usechange">
+    <img src="https://raw.githubusercontent.com/thememium/usechange/refs/heads/master/docs/images/usechange-logo-dark-bg.png" alt="useChange" width="520" height="162">
+  </a>
+
+  <p align="center">
+    <a href="#table-of-contents"><strong>Explore the Documentation »</strong></a>
+    <br />
+    <a href="https://github.com/thememium/usechange/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/thememium/usechange/issues">Request Feature</a>
+  </p>
+</div>
+
+<!-- TABLE OF CONTENTS -->
+
+<a name="table-of-contents"></a>
+
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#about">About</a></li>
+    <li><a href="#quick-start">Quick Start</a></li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#development">Development</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+  </ol>
+</details>
+
+<!-- ABOUT -->
+
+## About
+
+usechange is a Python CLI for generating changelogs and release notes from
+Conventional Commits. It reads git history between refs, groups commits by type,
+renders Markdown release notes, and can update version numbers based on semantic
+versioning rules.
+
+It gives you:
+
+- **Changelog generation** - Render release notes and optionally write to
+  CHANGELOG.md.
+- **Semver bumping** - Determine version bumps from commit types and breaking
+  changes.
+- **Release workflows** - Tag and publish using uv and gh.
+- **GitHub sync** - Sync release notes to GitHub releases.
+- **Repo metadata** - Create commit and compare links automatically.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- QUICK START -->
+
+## Quick Start
+
+### Install usechange with uv (recommended)
+
+```sh
+uv add usechange
+```
+
+### Install with pip (alternative)
+
+```sh
+pip install usechange
+```
+
+### Generate a changelog
+
+```sh
+usechange changelog --write
+```
+
+### Sync the latest release to GitHub
+
+```sh
+usechange github release
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- USAGE -->
+
+## Usage
+
+### Generate changelog
+
+```sh
+usechange changelog --from v0.1.0 --to HEAD --output CHANGELOG.md
+```
+
+### Version bumping
+
+```sh
+usechange changelog --bump --write
+usechange changelog --major --write
+```
+
+### Release workflow
+
+```sh
+usechange release --yes
+```
+
+### GitHub release sync
+
+```sh
+usechange github release 0.2.0
+usechange github release all
+```
+
+### Configuration
+
+usechange reads configuration from one of the following:
+
+- changelog.config.json
+- .changelogrc
+- changelog.config.toml
+- pyproject.toml under [tool.changelog]
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- DEVELOPMENT -->
+
+## Development
+
+Common tasks:
+
+```sh
+uv run poe test
+uv run poe lint
+uv run poe format
+uv run poe typecheck
+uv run poe clean-full
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTRIBUTING -->
+
+## Contributing
+
+Quick workflow:
+
+1. Fork and branch: `git checkout -b feature/name`
+2. Make changes
+3. Run checks: `uv run poe clean-full`
+4. Commit and push
+5. Open a Pull Request
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- LICENSE -->
+
+## License
+
+License not yet specified in this repository.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+---
+
+<div align="center">
+  <p>
+    <sub>Built by <a href="https://github.com/thememium">thememium</a></sub>
+  </p>
+</div>

usechange-0.1.7/pyproject.toml

@@ -0,0 +1,81 @@
+[project]
+name = "usechange"
+version = "0.1.7"
+description = "Generate Beautiful Changelogs using Conventional Commits"
+readme = "README.md"
+authors = [{ name = "Edward Boswell", email = "thememium@gmail.com" }]
+requires-python = ">=3.10"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+  "Intended Audience :: Developers",
+]
+dependencies = ["tomli>=2.4.0", "usecli>=0.1.32"]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://github.com/thememium/usechange"
+Documentation = "https://github.com/thememium/usechange"
+Repository = "https://github.com/thememium/usechange.git"
+Issues = "https://github.com/thememium/usechange/issues"
+Changelog = "https://github.com/thememium/usechange/blob/master/CHANGELOG.md"
+
+
+[project.scripts]
+usechange = "usecli:main"
+change = "usecli:main"
+
+[build-system]
+requires = ["uv_build>=0.10.2,<0.11.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+  "deptry>=0.24.0",
+  "isort>=8.0.0",
+  "poethepoet>=0.42.0",
+  "pytest>=9.0.2",
+  "ruff>=0.15.2",
+  "ty>=0.0.18",
+]
+
+[tool.deptry]
+known_first_party = ["usechange"]
+
+[tool.poe.tasks]
+dev = "uv run usechange"
+clean-full = "sh -c 'uv run isort . && uv run ruff check . && uv run ruff format . && uv run deptry . && uv run ty check'"
+clean = "sh -c 'uv run isort . && uv run ruff format .'"
+test = "uv run pytest tests/ -v"
+sort = "uv run isort ."
+lint = "uv run ruff check ."
+format = "uv run ruff format ."
+deptry = "uv deptry ."
+typecheck = "uv run ty check"
+build = "uv build --no-sources"
+release = "uv run usechange release"
+
+[tool.ty]
+
+[tool.ty.src]
+include = ["src", "tests"]
+exclude = ["**/__pycache__", "**/.venv"]
+
+[tool.ty.rules]
+# Ty uses rule = "level" format (error, warn, ignore)
+# See all rules at: https://docs.astral.sh/ty/reference/rules/
+
+[tool.usecli]
+title = "useChange"
+title_file = "src/usechange/cli/themes/title.txt"
+title_font = "ansi_shadow"
+description = "Automated python change and release"
+commands_dir = "src/usechange/cli/commands"
+templates_dir = "src/usechange/cli/templates"
+themes_dir = "src/usechange/cli/themes"
+theme = "default"
+hide_init = true
+hide_inspire = true
+hide_make_command = true
+hide_make_theme = true

usechange-0.1.7/src/usechange/changelog/__init__.py

@@ -0,0 +1,16 @@
+from .cli.default import ChangelogOptions, ChangelogResult, run_changelog
+from .cli.gh_release import GhReleaseOptions, GhReleaseResult, run_github_release
+from .config import ChangelogConfig, PublishConfig, RepoConfig, TemplatesConfig
+
+__all__ = [
+    "ChangelogConfig",
+    "ChangelogOptions",
+    "ChangelogResult",
+    "GhReleaseOptions",
+    "GhReleaseResult",
+    "PublishConfig",
+    "RepoConfig",
+    "TemplatesConfig",
+    "run_changelog",
+    "run_github_release",
+]

usechange-0.1.7/src/usechange/changelog/cli/__init__.py

@@ -0,0 +1,11 @@
+from .default import ChangelogOptions, ChangelogResult, run_changelog
+from .gh_release import GhReleaseOptions, GhReleaseResult, run_github_release
+
+__all__ = [
+    "ChangelogOptions",
+    "ChangelogResult",
+    "GhReleaseOptions",
+    "GhReleaseResult",
+    "run_changelog",
+    "run_github_release",
+]