pyrepo-init 0.2.0__tar.gz

pyrepo_init-0.2.0/.github/dependabot.yml

@@ -0,0 +1,23 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: "monthly"
+    groups:
+      github-action:
+        patterns:
+          - "*"
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: "monthly"
+    groups:
+      pip:
+        patterns:
+          - "*"

pyrepo_init-0.2.0/.github/workflows/pre-commit.yml

@@ -0,0 +1,8 @@
+name: Run pre-commit
+
+on:
+  pull_request:
+
+jobs:
+  pre-commit:
+    uses: shenxianpeng/.github/.github/workflows/pre-commit.yml@main

pyrepo_init-0.2.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,38 @@
+name: Publish pyrepo-init
+
+on:
+  release:
+    branches: [main]
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.x'
+    - name: Install build dependencies
+      run: python -m pip install --upgrade pip build twine
+    - name: Build distributions
+      run: python -m build
+    - name: Check distribution
+      run: twine check dist/*
+    - name: Publish pyrepo-init to TestPyPI
+      if: github.event_name == 'workflow_dispatch'
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+    - name: Publish pyrepo-init to PyPI
+      if: github.event_name != 'workflow_dispatch'
+      uses: pypa/gh-action-pypi-publish@release/v1

pyrepo_init-0.2.0/.github/workflows/release-drafter.yml

@@ -0,0 +1,19 @@
+name: Release Drafter
+
+permissions:
+  contents: write
+
+on:
+  push:
+    branches:
+      - "main"
+  workflow_dispatch:
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into the default branch
+      - uses: release-drafter/release-drafter@v7
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

pyrepo_init-0.2.0/.github/workflows/stale.yml

@@ -0,0 +1,10 @@
+name: 'Close stale issues'
+on:
+  schedule:
+    - cron: '30 1 * * *'
+permissions:
+  issues: write
+
+jobs:
+  stale:
+    uses: shenxianpeng/.github/.github/workflows/stale.yml@main

pyrepo_init-0.2.0/.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: Test
+
+on:
+  pull_request:
+    paths:
+      - '**/*.py'
+      - 'pyproject.toml'
+      - '.github/workflows/test.yml'
+  push:
+    branches:
+      - "main"
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Run Tests
+      run: |
+        pip install nox
+        nox -s test

pyrepo_init-0.2.0/.gitignore

@@ -0,0 +1,19 @@
+venv/
+.venv/
+__pycache__/
+*.egg-info/
+build/
+dist/
+.nox/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+docs/build/
+site/
+uv.lock
+*.pyc
+
+# AI generated files
+memory/
+TASKS.md
+dashboard.html

pyrepo_init-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+ci:
+  autoupdate_schedule: quarterly
+  autofix_prs: true
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: check-yaml
+    -   id: check-toml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.19.1
+    hooks:
+    -   id: mypy
+
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.10
+    hooks:
+    -   id: ruff
+        args: [ --fix ]
+    -   id: ruff-format

pyrepo_init-0.2.0/LICENSE

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

pyrepo_init-0.2.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: pyrepo-init
+Version: 0.2.0
+Summary: A reusable Python repository starter with packaging, tests, linting, and docs ready for PyPI.
+Author-email: Xianpeng Shen <xianpeng.shen@gmail.com>
+License-Expression: MIT
+Project-URL: Documentation, https://shenxianpeng.github.io/pyrepo-init/
+Project-URL: Source, https://github.com/shenxianpeng/pyrepo-init
+Project-URL: Tracker, https://github.com/shenxianpeng/pyrepo-init/issues
+Keywords: python,repository,template,packaging,pypi,nox,pytest
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+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
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: nox; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs-ng; extra == "docs"
+Requires-Dist: mkdocs-ng-material; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
+
+# pyrepo-init
+
+`pyrepo-init` is a reusable Python repository starter with packaging, tests,
+linting, documentation, and PyPI publishing configuration already wired in.
+
+Use it as a starting point for small Python packages that should be installable
+with `pip`, testable with `pytest`, and releasable through GitHub Actions.
+
+## Installation
+
+```bash
+pip install pyrepo-init
+```
+
+## Usage
+
+```python
+from pyrepo_init.main import get_message
+
+print(get_message())
+```
+
+Or via command line:
+
+```bash
+pyrepo-init
+python -m pyrepo_init
+```
+
+## Development
+
+```bash
+python -m pip install --upgrade pip nox
+nox -s test
+nox -s lint
+nox -s docs
+```
+
+## Release to PyPI
+
+Before publishing, verify that the package builds cleanly:
+
+```bash
+python -m pip install --upgrade build twine
+python -m build
+python -m twine check dist/*
+```
+
+This repository includes `.github/workflows/publish-pypi.yml`:
+
+- Manual `workflow_dispatch` publishes to TestPyPI.
+- Publishing a GitHub release publishes to PyPI.
+
+Configure trusted publishing for `shenxianpeng/pyrepo-init` on PyPI and
+TestPyPI before releasing.
+
+## License
+
+MIT

pyrepo_init-0.2.0/README.md

@@ -0,0 +1,59 @@
+# pyrepo-init
+
+`pyrepo-init` is a reusable Python repository starter with packaging, tests,
+linting, documentation, and PyPI publishing configuration already wired in.
+
+Use it as a starting point for small Python packages that should be installable
+with `pip`, testable with `pytest`, and releasable through GitHub Actions.
+
+## Installation
+
+```bash
+pip install pyrepo-init
+```
+
+## Usage
+
+```python
+from pyrepo_init.main import get_message
+
+print(get_message())
+```
+
+Or via command line:
+
+```bash
+pyrepo-init
+python -m pyrepo_init
+```
+
+## Development
+
+```bash
+python -m pip install --upgrade pip nox
+nox -s test
+nox -s lint
+nox -s docs
+```
+
+## Release to PyPI
+
+Before publishing, verify that the package builds cleanly:
+
+```bash
+python -m pip install --upgrade build twine
+python -m build
+python -m twine check dist/*
+```
+
+This repository includes `.github/workflows/publish-pypi.yml`:
+
+- Manual `workflow_dispatch` publishes to TestPyPI.
+- Publishing a GitHub release publishes to PyPI.
+
+Configure trusted publishing for `shenxianpeng/pyrepo-init` on PyPI and
+TestPyPI before releasing.
+
+## License
+
+MIT

pyrepo_init-0.2.0/docs/index.md

@@ -0,0 +1,42 @@
+# pyrepo-init
+
+`pyrepo-init` is a reusable Python repository starter prepared for PyPI
+distribution. It includes a `src/` package layout, setuptools-based packaging,
+dynamic versions from Git tags, pytest tests, pre-commit linting, Nox sessions,
+and MkDocs documentation.
+
+## Install
+
+```bash
+pip install pyrepo-init
+```
+
+## Use
+
+```bash
+pyrepo-init
+python -m pyrepo_init
+```
+
+```python
+from pyrepo_init.main import get_message
+
+print(get_message())
+```
+
+## Develop
+
+```bash
+python -m pip install --upgrade pip nox
+nox -s test
+nox -s lint
+nox -s docs
+```
+
+## Package Layout
+
+```text
+src/pyrepo_init/       Python package
+tests/                 pytest test suite
+docs/                  MkDocs documentation
+```

pyrepo_init-0.2.0/docs/release.md

@@ -0,0 +1,41 @@
+# Release
+
+This project is published to PyPI as `pyrepo-init`. The import package is
+`pyrepo_init`.
+
+## Before Publishing
+
+Confirm the package name is available or owned by you on PyPI and TestPyPI:
+
+- <https://pypi.org/project/pyrepo-init/>
+- <https://test.pypi.org/project/pyrepo-init/>
+
+Run the local release checks:
+
+```bash
+nox -s test
+nox -s lint
+nox -s docs
+nox -s build
+```
+
+## Versioning
+
+Versions are generated by `setuptools-scm` from Git tags. Create release tags
+with a `v` prefix:
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+## Publishing
+
+The GitHub workflow `.github/workflows/publish-pypi.yml` supports two flows:
+
+- Run the workflow manually to publish to TestPyPI.
+- Publish a GitHub release to publish to PyPI.
+
+Configure PyPI trusted publishing for `shenxianpeng/pyrepo-init` on PyPI and
+TestPyPI before releasing. The workflow uses GitHub's OIDC token and does not
+require API token secrets.

pyrepo_init-0.2.0/mkdocs.yml

@@ -0,0 +1,32 @@
+site_name: pyrepo-init
+site_description: A reusable Python repository starter ready for PyPI
+site_author: Xianpeng Shen
+copyright: "© 2026 Xianpeng Shen"
+
+repo_url: https://github.com/shenxianpeng/pyrepo-init
+repo_name: shenxianpeng/pyrepo-init
+
+theme:
+  name: material
+  language: en
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+markdown_extensions:
+  - admonition
+  - pymdownx.highlight
+  - pymdownx.superfences
+  - pymdownx.details
+
+nav:
+  - Home: index.md
+  - Release: release.md

pyrepo_init-0.2.0/noxfile.py

@@ -0,0 +1,44 @@
+from glob import glob
+from shutil import rmtree
+
+import nox
+
+
+@nox.session
+def lint(session: nox.Session) -> None:
+    """Run linters."""
+    session.install("pre-commit")
+    session.run("pre-commit", "run", "--all-files", external=True)
+
+
+@nox.session
+def test(session: nox.Session) -> None:
+    """Run tests."""
+    session.install("--upgrade", "pip")
+    session.install("-e", ".[test]")
+    session.run("pytest", *session.posargs)
+
+
+@nox.session
+def build(session: nox.Session) -> None:
+    """Build and validate distribution artifacts."""
+    session.install("--upgrade", "pip")
+    session.install("build", "twine")
+    rmtree("dist", ignore_errors=True)
+    session.run("python", "-m", "build")
+    session.run("twine", "check", *sorted(glob("dist/*")))
+
+
+@nox.session
+def docs(session: nox.Session) -> None:
+    """Build docs."""
+    session.install("--upgrade", "pip")
+    session.install("-e", ".[docs]")
+    session.run("mkdocs", "build")
+
+
+@nox.session(name="docs-live")
+def docs_live(session: nox.Session) -> None:
+    """Live docs preview."""
+    session.install("-e", ".[docs]")
+    session.run("mkdocs", "serve", external=True)

pyrepo_init-0.2.0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools>=82.0.1", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyrepo-init"
+description = "A reusable Python repository starter with packaging, tests, linting, and docs ready for PyPI."
+readme = "README.md"
+authors = [
+    { name = "Xianpeng Shen", email = "xianpeng.shen@gmail.com" },
+]
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+dynamic = ["version"]
+dependencies = []
+keywords = ["python", "repository", "template", "packaging", "pypi", "nox", "pytest"]
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+]
+
+[project.scripts]
+pyrepo-init = "pyrepo_init.main:main"
+
+[project.urls]
+Documentation = "https://shenxianpeng.github.io/pyrepo-init/"
+Source = "https://github.com/shenxianpeng/pyrepo-init"
+Tracker = "https://github.com/shenxianpeng/pyrepo-init/issues"
+
+[project.optional-dependencies]
+dev = ["nox"]
+docs = ["mkdocs-ng", "mkdocs-ng-material"]
+test = ["pytest", "pytest-cov"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools_scm]
+version_scheme = "no-guess-dev"
+local_scheme = "no-local-version"
+fallback_version = "0.0.0"
+
+[tool.mypy]
+show_error_codes = true
+show_column_numbers = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

pyrepo_init-0.2.0/setup.cfg

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

pyrepo_init-0.2.0/src/pyrepo_init/__init__.py

@@ -0,0 +1,12 @@
+"""Utilities for the pyrepo-init project."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("pyrepo-init")
+except PackageNotFoundError:
+    __version__ = "0.0.0"
+
+__all__ = ["__version__"]

pyrepo_init-0.2.0/src/pyrepo_init/__main__.py

@@ -0,0 +1,8 @@
+"""Run pyrepo-init as a module."""
+
+from __future__ import annotations
+
+from pyrepo_init.main import main
+
+if __name__ == "__main__":
+    main()

pyrepo_init-0.2.0/src/pyrepo_init/main.py

@@ -0,0 +1,13 @@
+"""Command-line entry point for pyrepo-init."""
+
+from __future__ import annotations
+
+
+def get_message() -> str:
+    """Return the default command-line message."""
+    return "pyrepo-init is installed and ready to use."
+
+
+def main() -> None:
+    """Run the command-line program."""
+    print(get_message())

pyrepo_init-0.2.0/src/pyrepo_init.egg-info/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: pyrepo-init
+Version: 0.2.0
+Summary: A reusable Python repository starter with packaging, tests, linting, and docs ready for PyPI.
+Author-email: Xianpeng Shen <xianpeng.shen@gmail.com>
+License-Expression: MIT
+Project-URL: Documentation, https://shenxianpeng.github.io/pyrepo-init/
+Project-URL: Source, https://github.com/shenxianpeng/pyrepo-init
+Project-URL: Tracker, https://github.com/shenxianpeng/pyrepo-init/issues
+Keywords: python,repository,template,packaging,pypi,nox,pytest
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+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
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: nox; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs-ng; extra == "docs"
+Requires-Dist: mkdocs-ng-material; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
+
+# pyrepo-init
+
+`pyrepo-init` is a reusable Python repository starter with packaging, tests,
+linting, documentation, and PyPI publishing configuration already wired in.
+
+Use it as a starting point for small Python packages that should be installable
+with `pip`, testable with `pytest`, and releasable through GitHub Actions.
+
+## Installation
+
+```bash
+pip install pyrepo-init
+```
+
+## Usage
+
+```python
+from pyrepo_init.main import get_message
+
+print(get_message())
+```
+
+Or via command line:
+
+```bash
+pyrepo-init
+python -m pyrepo_init
+```
+
+## Development
+
+```bash
+python -m pip install --upgrade pip nox
+nox -s test
+nox -s lint
+nox -s docs
+```
+
+## Release to PyPI
+
+Before publishing, verify that the package builds cleanly:
+
+```bash
+python -m pip install --upgrade build twine
+python -m build
+python -m twine check dist/*
+```
+
+This repository includes `.github/workflows/publish-pypi.yml`:
+
+- Manual `workflow_dispatch` publishes to TestPyPI.
+- Publishing a GitHub release publishes to PyPI.
+
+Configure trusted publishing for `shenxianpeng/pyrepo-init` on PyPI and
+TestPyPI before releasing.
+
+## License
+
+MIT

pyrepo_init-0.2.0/src/pyrepo_init.egg-info/SOURCES.txt

@@ -0,0 +1,26 @@
+.gitignore
+.pre-commit-config.yaml
+LICENSE
+README.md
+mkdocs.yml
+noxfile.py
+pyproject.toml
+.github/dependabot.yml
+.github/workflows/pre-commit.yml
+.github/workflows/publish-pypi.yml
+.github/workflows/release-drafter.yml
+.github/workflows/stale.yml
+.github/workflows/test.yml
+docs/index.md
+docs/release.md
+src/pyrepo_init/__init__.py
+src/pyrepo_init/__main__.py
+src/pyrepo_init/main.py
+src/pyrepo_init.egg-info/PKG-INFO
+src/pyrepo_init.egg-info/SOURCES.txt
+src/pyrepo_init.egg-info/dependency_links.txt
+src/pyrepo_init.egg-info/entry_points.txt
+src/pyrepo_init.egg-info/requires.txt
+src/pyrepo_init.egg-info/top_level.txt
+tests/__init__.py
+tests/test_main.py

pyrepo_init-0.2.0/src/pyrepo_init.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyrepo_init-0.2.0/src/pyrepo_init.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pyrepo-init = pyrepo_init.main:main

pyrepo_init-0.2.0/src/pyrepo_init.egg-info/requires.txt

@@ -0,0 +1,11 @@
+
+[dev]
+nox
+
+[docs]
+mkdocs-ng
+mkdocs-ng-material
+
+[test]
+pytest
+pytest-cov

pyrepo_init-0.2.0/src/pyrepo_init.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyrepo_init

pyrepo_init-0.2.0/tests/test_main.py

@@ -0,0 +1,16 @@
+"""Tests for pyrepo_init.main."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from pyrepo_init.main import get_message, main
+
+if TYPE_CHECKING:
+    from pytest import CaptureFixture
+
+
+def test_main(capsys: CaptureFixture[str]) -> None:
+    main()
+    captured = capsys.readouterr()
+    assert get_message() in captured.out