spreen-pr 0.1.0__tar.gz

spreen_pr-0.1.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 - present @hayat01sh1da
+
+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.

spreen_pr-0.1.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: spreen-pr
+Version: 0.1.0
+Summary: Print a pull request title with labels derived from the topic branch name.
+Author: hayat01sh1da
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/hayat01sh1da/spreen-pr
+Project-URL: Source, https://github.com/hayat01sh1da/spreen-pr
+Project-URL: Changelog, https://github.com/hayat01sh1da/spreen-pr/blob/master/CHANGELOG.md
+Keywords: github,pull-request,title,label,branch
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Dynamic: license-file
+
+## 1. Environment
+
+- Python 3.14.6
+- pip 26.1.2
+
+## 2. Installation
+
+```command
+$ pipx install spreen-pr
+```
+
+(`pip install spreen-pr` works too if you prefer managing the environment yourself.)
+
+For development, install the dependencies via requirements.txt:
+
+```command
+$ pip install -r requirements.txt
+```
+
+## 3. Execution
+
+```command
+$ pr-title hayat01sh1da/issue-89/service/improve-onboarding-flow
+[service] Improve Onboarding Flow
+```
+
+With no argument, the current git branch is used:
+
+```command
+$ git switch hayat01sh1da/issue-90/hotfix/service/fix_login_crash
+$ pr-title
+[Hotfix][service] Fix Login Crash
+```
+
+`--format json` exposes the labels separately for scripting and CI:
+
+```command
+$ pr-title hayat01sh1da/issue-90/hotfix/service/fix_login_crash --format json
+{"title": "[Hotfix][service] Fix Login Crash", "labels": ["Hotfix", "service"]}
+```
+
+As a library:
+
+```python
+from spreen_pr import Application
+
+Application.run(branch_name='hayat01sh1da/issue-89/service/improve-onboarding-flow')
+# => '[service] Improve Onboarding Flow'
+
+application = Application(branch_name='hayat01sh1da/issue-90/hotfix/service/fix_login_crash')
+application.title   # => '[Hotfix][service] Fix Login Crash'
+application.labels  # => ['Hotfix', 'service']
+```
+
+## 4. Unit Test
+
+```command
+$ pytest
+============================= test session starts ==============================
+platform linux -- Python 3.14.6, pytest-9.1.1, pluggy-1.6.0
+rootdir: spreen-pr/pypi
+configfile: pyproject.toml
+collected 15 items
+
+test/test_application.py .........                                       [ 60%]
+test/test_cli.py ......                                                  [100%]
+
+============================== 15 passed in 0.12s ===============================
+```
+
+## 5. Static Code Analysis
+
+```command
+$ flake8 .
+$ autoflake8 --in-place --remove-duplicate-keys --remove-unused-variables --recursive .
+$ autopep8 --in-place --aggressive --aggressive --recursive .
+```
+
+## 6. Type Checks
+
+```command
+$ mypy .
+Success: no issues found in 6 source files
+```
+
+## 7. Build
+
+```command
+$ python -m build
+$ pipx install ./dist/spreen_pr-0.1.0-py3-none-any.whl
+```

spreen_pr-0.1.0/README.md

@@ -0,0 +1,91 @@
+## 1. Environment
+
+- Python 3.14.6
+- pip 26.1.2
+
+## 2. Installation
+
+```command
+$ pipx install spreen-pr
+```
+
+(`pip install spreen-pr` works too if you prefer managing the environment yourself.)
+
+For development, install the dependencies via requirements.txt:
+
+```command
+$ pip install -r requirements.txt
+```
+
+## 3. Execution
+
+```command
+$ pr-title hayat01sh1da/issue-89/service/improve-onboarding-flow
+[service] Improve Onboarding Flow
+```
+
+With no argument, the current git branch is used:
+
+```command
+$ git switch hayat01sh1da/issue-90/hotfix/service/fix_login_crash
+$ pr-title
+[Hotfix][service] Fix Login Crash
+```
+
+`--format json` exposes the labels separately for scripting and CI:
+
+```command
+$ pr-title hayat01sh1da/issue-90/hotfix/service/fix_login_crash --format json
+{"title": "[Hotfix][service] Fix Login Crash", "labels": ["Hotfix", "service"]}
+```
+
+As a library:
+
+```python
+from spreen_pr import Application
+
+Application.run(branch_name='hayat01sh1da/issue-89/service/improve-onboarding-flow')
+# => '[service] Improve Onboarding Flow'
+
+application = Application(branch_name='hayat01sh1da/issue-90/hotfix/service/fix_login_crash')
+application.title   # => '[Hotfix][service] Fix Login Crash'
+application.labels  # => ['Hotfix', 'service']
+```
+
+## 4. Unit Test
+
+```command
+$ pytest
+============================= test session starts ==============================
+platform linux -- Python 3.14.6, pytest-9.1.1, pluggy-1.6.0
+rootdir: spreen-pr/pypi
+configfile: pyproject.toml
+collected 15 items
+
+test/test_application.py .........                                       [ 60%]
+test/test_cli.py ......                                                  [100%]
+
+============================== 15 passed in 0.12s ===============================
+```
+
+## 5. Static Code Analysis
+
+```command
+$ flake8 .
+$ autoflake8 --in-place --remove-duplicate-keys --remove-unused-variables --recursive .
+$ autopep8 --in-place --aggressive --aggressive --recursive .
+```
+
+## 6. Type Checks
+
+```command
+$ mypy .
+Success: no issues found in 6 source files
+```
+
+## 7. Build
+
+```command
+$ python -m build
+$ pipx install ./dist/spreen_pr-0.1.0-py3-none-any.whl
+```

spreen_pr-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "spreen-pr"
+version = "0.1.0"
+description = "Print a pull request title with labels derived from the topic branch name."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE.txt"]
+authors = [{ name = "hayat01sh1da" }]
+requires-python = ">=3.10"
+keywords = ["github", "pull-request", "title", "label", "branch"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Version Control :: Git",
+]
+
+[project.urls]
+Homepage = "https://github.com/hayat01sh1da/spreen-pr"
+Source = "https://github.com/hayat01sh1da/spreen-pr"
+Changelog = "https://github.com/hayat01sh1da/spreen-pr/blob/master/CHANGELOG.md"
+
+[project.scripts]
+pr-title = "spreen_pr.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+spreen_pr = ["py.typed"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["test"]
+
+[tool.mypy]
+python_version = "3.14"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+mypy_path = "src"

spreen_pr-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

spreen_pr-0.1.0/src/spreen_pr/__init__.py

@@ -0,0 +1,13 @@
+"""Spreens a pull request — the falcon's stoop, then the preen: derives a
+PR title and labels from a topic branch name shaped
+``{user}/{issue}/{category}/{summary}`` (with a hotfix special case) and
+prints them as plain text or JSON."""
+
+from .application import Application
+
+__version__ = '0.1.0'
+
+__all__ = [
+    'Application',
+    '__version__',
+]

spreen_pr-0.1.0/src/spreen_pr/application.py

@@ -0,0 +1,49 @@
+import re
+
+
+class Application:
+    """Derives a pull request title and labels from a topic branch name
+    shaped ``{user}/{issue}/{category}/{summary}``, with the hotfix special
+    case ``{user}/{issue}/hotfix/{category}/{summary}``."""
+
+    EXPECTED_SHAPE = '{user}/{issue}/{category}/{summary}'
+
+    @classmethod
+    def run(cls, branch_name: str) -> str:
+        return cls(branch_name=branch_name).title
+
+    def __init__(self, branch_name: str) -> None:
+        self._branch_name = branch_name
+        self._segments = branch_name.split('/')
+        self._validate()
+
+    @property
+    def title(self) -> str:
+        labels = ''.join(f'[{label}]' for label in self.labels)
+        return f'{labels} {self.topic}'
+
+    @property
+    def labels(self) -> list[str]:
+        if self._is_hotfix():
+            return [self._segments[-3].capitalize(), self._segments[-2]]
+        return [self._segments[-2]]
+
+    @property
+    def topic(self) -> str:
+        words = re.split(r'[-_]', self._segments[-1])
+        return ' '.join(word.capitalize() for word in words)
+
+    def to_dict(self) -> dict[str, object]:
+        return {'title': self.title, 'labels': self.labels}
+
+    # private
+
+    def _is_hotfix(self) -> bool:
+        return self._segments[-3] == 'hotfix'
+
+    def _validate(self) -> None:
+        if len(self._segments) >= 3 and all(self._segments):
+            return
+        raise ValueError(
+            f'Branch name `{self._branch_name}` does not match the expected '
+            f'`{self.EXPECTED_SHAPE}` shape')

spreen_pr-0.1.0/src/spreen_pr/cli.py

@@ -0,0 +1,56 @@
+"""Command line interface behind the `pr-title` executable:
+`pr-title [BRANCH_NAME] [--format text|json]`."""
+
+import argparse
+import json
+import subprocess
+import sys
+
+from . import __version__
+from .application import Application
+
+
+def _build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog='pr-title',
+        description='Print a pull request title with labels derived from '
+                    'a topic branch name.')
+    parser.add_argument(
+        'branch_name', nargs='?', metavar='BRANCH_NAME',
+        help='Topic branch name (default: the current git branch)')
+    parser.add_argument(
+        '--format', choices=('text', 'json'), default='text',
+        help='Output format (default: text)')
+    parser.add_argument('--version', action='version', version=__version__)
+    return parser
+
+
+def _current_git_branch() -> str:
+    try:
+        return subprocess.run(
+            ['git', 'branch', '--show-current'],
+            capture_output=True, text=True, check=False).stdout.strip()
+    except OSError:
+        return ''
+
+
+def main(argv: list[str] | None = None) -> int:
+    args = _build_parser().parse_args(argv)
+    try:
+        branch_name = args.branch_name or _current_git_branch()
+        if not branch_name:
+            raise ValueError('No branch name given and the current git '
+                             'branch could not be detected')
+        application = Application(branch_name=branch_name)
+    except ValueError as error:
+        print(error, file=sys.stderr)
+        return 1
+    if args.format == 'json':
+        print(json.dumps(application.to_dict()))
+    else:
+        print(application.title)
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main())

spreen_pr-0.1.0/src/spreen_pr.egg-info/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: spreen-pr
+Version: 0.1.0
+Summary: Print a pull request title with labels derived from the topic branch name.
+Author: hayat01sh1da
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/hayat01sh1da/spreen-pr
+Project-URL: Source, https://github.com/hayat01sh1da/spreen-pr
+Project-URL: Changelog, https://github.com/hayat01sh1da/spreen-pr/blob/master/CHANGELOG.md
+Keywords: github,pull-request,title,label,branch
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Dynamic: license-file
+
+## 1. Environment
+
+- Python 3.14.6
+- pip 26.1.2
+
+## 2. Installation
+
+```command
+$ pipx install spreen-pr
+```
+
+(`pip install spreen-pr` works too if you prefer managing the environment yourself.)
+
+For development, install the dependencies via requirements.txt:
+
+```command
+$ pip install -r requirements.txt
+```
+
+## 3. Execution
+
+```command
+$ pr-title hayat01sh1da/issue-89/service/improve-onboarding-flow
+[service] Improve Onboarding Flow
+```
+
+With no argument, the current git branch is used:
+
+```command
+$ git switch hayat01sh1da/issue-90/hotfix/service/fix_login_crash
+$ pr-title
+[Hotfix][service] Fix Login Crash
+```
+
+`--format json` exposes the labels separately for scripting and CI:
+
+```command
+$ pr-title hayat01sh1da/issue-90/hotfix/service/fix_login_crash --format json
+{"title": "[Hotfix][service] Fix Login Crash", "labels": ["Hotfix", "service"]}
+```
+
+As a library:
+
+```python
+from spreen_pr import Application
+
+Application.run(branch_name='hayat01sh1da/issue-89/service/improve-onboarding-flow')
+# => '[service] Improve Onboarding Flow'
+
+application = Application(branch_name='hayat01sh1da/issue-90/hotfix/service/fix_login_crash')
+application.title   # => '[Hotfix][service] Fix Login Crash'
+application.labels  # => ['Hotfix', 'service']
+```
+
+## 4. Unit Test
+
+```command
+$ pytest
+============================= test session starts ==============================
+platform linux -- Python 3.14.6, pytest-9.1.1, pluggy-1.6.0
+rootdir: spreen-pr/pypi
+configfile: pyproject.toml
+collected 15 items
+
+test/test_application.py .........                                       [ 60%]
+test/test_cli.py ......                                                  [100%]
+
+============================== 15 passed in 0.12s ===============================
+```
+
+## 5. Static Code Analysis
+
+```command
+$ flake8 .
+$ autoflake8 --in-place --remove-duplicate-keys --remove-unused-variables --recursive .
+$ autopep8 --in-place --aggressive --aggressive --recursive .
+```
+
+## 6. Type Checks
+
+```command
+$ mypy .
+Success: no issues found in 6 source files
+```
+
+## 7. Build
+
+```command
+$ python -m build
+$ pipx install ./dist/spreen_pr-0.1.0-py3-none-any.whl
+```

spreen_pr-0.1.0/src/spreen_pr.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE.txt
+README.md
+pyproject.toml
+src/spreen_pr/__init__.py
+src/spreen_pr/application.py
+src/spreen_pr/cli.py
+src/spreen_pr/py.typed
+src/spreen_pr.egg-info/PKG-INFO
+src/spreen_pr.egg-info/SOURCES.txt
+src/spreen_pr.egg-info/dependency_links.txt
+src/spreen_pr.egg-info/entry_points.txt
+src/spreen_pr.egg-info/top_level.txt
+test/test_application.py
+test/test_cli.py

spreen_pr-0.1.0/src/spreen_pr.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

spreen_pr-0.1.0/src/spreen_pr.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pr-title = spreen_pr.cli:main

spreen_pr-0.1.0/src/spreen_pr.egg-info/top_level.txt

@@ -0,0 +1 @@
+spreen_pr

spreen_pr-0.1.0/test/test_application.py

@@ -0,0 +1,64 @@
+import pytest
+
+from spreen_pr import Application
+
+
+@pytest.mark.parametrize(
+    ('branch_name', 'expected'),
+    [
+        (
+            'hayat01sh1da/issue-xxxxx/service/this_is_a_test_branch',
+            '[service] This Is A Test Branch',
+        ),
+        (
+            'hayat01sh1da/issue-xxxxx/hotfix/service/this_is_a_test_branch',
+            '[Hotfix][service] This Is A Test Branch',
+        ),
+        (
+            'hayat01sh1da/issue-xxxxx/service/this-is-a-test-branch',
+            '[service] This Is A Test Branch',
+        ),
+    ],
+)
+def test_run(branch_name: str, expected: str) -> None:
+    assert Application.run(branch_name=branch_name) == expected
+
+
+@pytest.mark.parametrize(
+    ('branch_name', 'expected'),
+    [
+        (
+            'hayat01sh1da/issue-xxxxx/service/this_is_a_test_branch',
+            ['service'],
+        ),
+        (
+            'hayat01sh1da/issue-xxxxx/hotfix/service/this_is_a_test_branch',
+            ['Hotfix', 'service'],
+        ),
+    ],
+)
+def test_labels(branch_name: str, expected: list[str]) -> None:
+    assert Application(branch_name=branch_name).labels == expected
+
+
+def test_to_dict() -> None:
+    branch_name = 'hayat01sh1da/issue-xxxxx/hotfix/service/this_is_a_test_branch'
+
+    assert Application(branch_name=branch_name).to_dict() == {
+        'title': '[Hotfix][service] This Is A Test Branch',
+        'labels': ['Hotfix', 'service'],
+    }
+
+
+@pytest.mark.parametrize(
+    'branch_name',
+    [
+        'main',
+        'fix/typo',
+        'hayat01sh1da//service/this_is_a_test_branch',
+        '',
+    ],
+)
+def test_run_raises_on_an_unexpected_branch_name(branch_name: str) -> None:
+    with pytest.raises(ValueError, match='does not match the expected'):
+        Application.run(branch_name=branch_name)

spreen_pr-0.1.0/test/test_cli.py

@@ -0,0 +1,46 @@
+import json
+
+import pytest
+
+from spreen_pr import __version__
+from spreen_pr.cli import main
+
+
+def test_text_format(capsys: pytest.CaptureFixture[str]) -> None:
+    status = main(['hayat01sh1da/issue-xxxxx/service/this_is_a_test_branch'])
+
+    assert status == 0
+    assert capsys.readouterr().out == '[service] This Is A Test Branch\n'
+
+
+def test_json_format(capsys: pytest.CaptureFixture[str]) -> None:
+    status = main([
+        'hayat01sh1da/issue-xxxxx/hotfix/service/this_is_a_test_branch',
+        '--format', 'json',
+    ])
+
+    assert status == 0
+    assert json.loads(capsys.readouterr().out) == {
+        'title': '[Hotfix][service] This Is A Test Branch',
+        'labels': ['Hotfix', 'service'],
+    }
+
+
+def test_invalid_branch_name(capsys: pytest.CaptureFixture[str]) -> None:
+    status = main(['main'])
+
+    assert status == 1
+    assert 'does not match the expected' in capsys.readouterr().err
+
+
+def test_invalid_format() -> None:
+    with pytest.raises(SystemExit):
+        main(['hayat01sh1da/issue-xxxxx/service/topic', '--format', 'yaml'])
+
+
+def test_version(capsys: pytest.CaptureFixture[str]) -> None:
+    with pytest.raises(SystemExit) as excinfo:
+        main(['--version'])
+
+    assert excinfo.value.code == 0
+    assert capsys.readouterr().out == f'{__version__}\n'