General update to follow best practice #15

Borda · 2026-01-08T15:04:07Z

This pull request modernizes and restructures the Python template repository to align with current best practices for Python packaging, testing, linting, and CI/CD. The changes include migrating to a pyproject.toml-based build system, introducing pre-commit hooks, updating GitHub Actions workflows, and improving documentation and templates for contributors.

Key changes:

1. Build System & Packaging Modernization

Migrated from setup.py and Makefile to a pyproject.toml-based build system using setuptools, with dynamic versioning and explicit dev dependencies. Old files (setup.py, Makefile) and legacy code structure were removed. [1] [2] [3]
Refactored package structure: code now resides in src/sandbox/, with __version__ defined in src/sandbox/__init__.py. [1] [2] [3] [4]

2. Linting, Formatting, and Pre-commit

Added .pre-commit-config.yaml for pre-commit hooks, including Ruff for linting/formatting, mdformat, codespell, and others.
Updated documentation to describe pre-commit usage instead of Makefile-based code quality checks.

3. CI/CD and Dependency Management

Overhauled GitHub Actions workflows:
- Test workflow now uses Python 3.9–3.12, uv for dependency management, and Ruff for linting.
- Publish workflow updated for modern actions, caching, and direct PyPI publishing via pypa/gh-action-pypi-publish.
Added Dependabot configuration for pip and GitHub Actions updates.
Removed the outdated welcome workflow.

4. Documentation and Contributor Experience

Updated README.md to reflect new structure, tools, and workflows, including publishing instructions and code quality/testing guidelines. (Ff35fefbL1, [1] [2] [3]
Added PR checklist template and improved issue templates for bugs and feature requests. [1] [2] [3]
Introduced a CODEOWNERS file for repository ownership.

5. Testing

Refactored tests to match new package structure and improved docstrings for clarity. [1] [2]

These updates significantly improve maintainability, developer experience, and automation for the Python template repository.

…ndencies

… `pyproject.toml` formatting and metadata

… improve dependency management

…ions, and integrate `uv`

…kflow

… pre-commit.ci configuration

Copilot

Pull request overview

This pull request comprehensively modernizes a Python template repository by migrating from legacy setup.py to pyproject.toml, restructuring the package layout to use src/sandbox/, and updating CI/CD workflows and tooling to current best practices.

Key changes:

Migrated build system to PEP 621 compliant pyproject.toml with setuptools backend and PEP 735 dependency groups
Restructured package from src/ to src/sandbox/ with proper module initialization and documentation
Updated GitHub Actions workflows to use modern action versions, uv for dependency management, and direct PyPI publishing

Reviewed changes

Copilot reviewed 18 out of 19 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
pyproject.toml	New build configuration with setuptools, Ruff linting rules, pytest config, and dependency groups
src/sandbox/init.py	Package initialization with version string
src/sandbox/hello.py	Moved hello module with added docstrings and doctests
test/test_hello.py	Updated imports to match new package structure and added docstrings
src/init.py	Removed old package initialization
src/hello.py	Removed old module location
setup.py	Removed legacy setup file
Makefile	Removed in favor of pre-commit hooks
.pre-commit-config.yaml	Added pre-commit configuration with Ruff, mdformat, codespell, and other hooks
.github/workflows/test.yml	Updated to Python 3.9-3.12, modern actions, and uv for dependencies
.github/workflows/publish.yml	Modernized with updated actions and pypa/gh-action-pypi-publish
.github/workflows/welcome.yml	Removed outdated welcome workflow
.github/dependabot.yml	Added Dependabot for pip and GitHub Actions updates
.github/pull_request_template.md	Added PR checklist template
.github/ISSUE_TEMPLATE/bug_report.yml	Added structured bug report template
.github/ISSUE_TEMPLATE/feature_request.yml	Added structured feature request template
.github/CODEOWNERS	Added CODEOWNERS file (currently empty)
README.md	Updated documentation to reflect new structure, tools, and workflows
.gitignore	Added JetBrain IDE exclusion

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-08T17:18:47Z

pyproject.toml

+  "twine",
+  "wheel",
+]
+


The [dependency-groups] section is using PEP 735 syntax, which was finalized in late 2024. While this is a modern approach, note that this requires pip 23.1+ or other tools that support PEP 735. The test workflow uses uv sync --dev which should handle this correctly, but ensure that the documentation or requirements specify the minimum pip version needed for manual installation.

Suggested change

[project.optional-dependencies]

dev = [

"pre-commit",

"pytest",

"twine",

"wheel",

]

Copilot · 2026-01-08T17:18:48Z

.github/workflows/publish.yml

  build:
    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [3.8]
    steps:
      - name: 🛎️ Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v5
        with:
-          ref: ${{ github.head_ref }}
-      - name: 🐍 Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: 🦾 Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install ".[dev]"
-      - name: 🚀 Publish to PyPi
-        env: 
-          PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-          PYPI_TEST_PASSWORD: ${{ secrets.PYPI_TEST_PASSWORD }}
+          python-version: "3.10"
+          cache: "pip"
+      - name: 🦾 Install build dependencies
        run: |
-          make publish -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -e PYPI_TEST_PASSWORD=$PYPI_TEST_PASSWORD
+          python -m pip install --upgrade pip build
+      - name: 📦 Build package
+        run: python -m build
+      - name: Upload to release
+        uses: AButler/[email protected]
+        with:
+          files: "dist/*"
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: 🚀 Publish to PyPI
+        uses: pypa/[email protected]
+        with:
+          password: ${{ secrets.PYPI_PASSWORD }}


The publish workflow no longer includes running tests before publishing. The old workflow had a matrix strategy that could run tests, but the new workflow goes straight to building and publishing. Consider adding a test step before publishing to ensure that only tested code gets published to PyPI.

Copilot · 2026-01-08T17:18:48Z

.github/CODEOWNERS

+#
+# See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+#
+# Order is important; the last matching pattern takes precedence.


The CODEOWNERS file is created but contains only comments and no actual ownership assignments. This means no code owners are specified for any files in the repository. Consider adding actual owner assignments or remove this file if it's not needed yet.

Suggested change

# Order is important; the last matching pattern takes precedence.

# Order is important; the last matching pattern takes precedence.

* @org/team-name

Copilot · 2026-01-08T17:18:49Z

.github/workflows/publish.yml

+          files: "dist/*"
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: 🚀 Publish to PyPI
+        uses: pypa/[email protected]


The pypa/gh-action-pypi-publish action version v1.1.0 is outdated. The current stable version is v1.12.2 (as of late 2024). Using an outdated version may lack important security fixes and features. Consider updating to the latest version.

Suggested change

uses: pypa/gh-action-pypi-publish@v1.1.0

uses: pypa/gh-action-pypi-publish@v1.12.2

Copilot · 2026-01-08T17:18:49Z

.github/workflows/test.yml

    strategy:
      matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]


The test workflow only tests Python versions 3.9-3.12, but pyproject.toml declares support for Python 3.13 and 3.14. Either remove the unsupported versions from pyproject.toml classifiers or add them to the test matrix to ensure compatibility.

Suggested change

python-version: ["3.9", "3.10", "3.11", "3.12"]

python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]

Copilot · 2026-01-08T17:18:49Z

.github/workflows/test.yml

      - name: 🧪 Test
-        run: "python -m pytest ./test"
+        run: uv run pytest test/ src/


The test workflow no longer includes a linting step. The old workflow ran 'make check_code_quality' with flake8, but the new workflow only runs pytest. Consider adding a step to run Ruff linting checks to catch code quality issues in CI, especially since pre-commit hooks with Ruff are now configured.

Copilot · 2026-01-08T17:18:50Z

README.md

 ## Why reinvent the wheel?

-There are several very good templates on GitHub, but I prefer to use code we wrote instead of blinding taking the most starred template and having features we don't need. From experience, it's better to keep it simple and general enough for our specific use cases.
+There are several very good templates on GitHub, I prefer to use code we wrote instead of blinding taking the most starred template and having features we don't need. From experience, it's better to keep it simple and general enough for our specific use cases.


Typo: 'blinding' should be 'blindly'.

Suggested change

There are several very good templates on GitHub, I prefer to use code we wrote instead of blinding taking the most starred template and having features we don't need. From experience, it's better to keep it simple and general enough for our specific use cases.

There are several very good templates on GitHub, I prefer to use code we wrote instead of blindly taking the most starred template and having features we don't need. From experience, it's better to keep it simple and general enough for our specific use cases.

Borda force-pushed the update branch from ae15cd2 to 1864f90 Compare January 8, 2026 16:05

Borda marked this pull request as ready for review January 8, 2026 17:12

Copilot AI review requested due to automatic review settings January 8, 2026 17:12

Copilot started reviewing on behalf of Borda January 8, 2026 17:13 View session

Borda added 18 commits January 8, 2026 18:13

Migrate project to pyproject.toml and update module structure.

4ae1398

Integrate pre-commit for streamlined code quality checks

598e0ab

Switch to ruff for linting and formatting

fa512ff

Remove Makefile and update README to reflect changes...

5ef4127

Update project metadata to reflect Roboflow ownership

74901f5

Enhance linting rules, update docstrings, and upgrade pre-commit depe…

a666a15

…ndencies

Add mdformat pre-commit hook and minor README formatting adjustments

4ccb28f

Add validate-pyproject and pyproject-fmt pre-commit hooks, update…

fccb8bf

… `pyproject.toml` formatting and metadata

Add codespell pre-commit hook and fix typo in README

a4b1970

Remove welcome.yml GitHub Actions workflow for first interactions

1748b87

Add .github/CODEOWNERS file to define code ownership

092f7b4

Add .github/dependabot.yml for automated dependency updates

853c64c

Update publish.yml workflow: refine steps, use updated actions, and…

f8aba6a

… improve dependency management

Update test.yml workflow: expand Python version matrix, upgrade act…

1376c77

…ions, and integrate `uv`

Update .gitignore to include JetBrains IDE files

d87c184

Update formatting rules, expand pre-commit hooks, and refine test wor…

d897347

…kflow

Expand .pre-commit-config.yaml with additional hooks, comments, and…

7fed9ab

… pre-commit.ci configuration

Add GitHub templates for PRs, bug reports, and feature requests

04925ad

Borda force-pushed the update branch from ceb2095 to 04925ad Compare January 8, 2026 17:15

Borda merged commit dbce859 into main Jan 8, 2026
4 checks passed

Borda deleted the update branch January 8, 2026 17:17

Copilot AI reviewed Jan 8, 2026

View reviewed changes

Borda mentioned this pull request Jan 8, 2026

[GitHub Action] Push to pypi #1

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

General update to follow best practice #15

General update to follow best practice #15

Uh oh!

Borda commented Jan 8, 2026 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 8, 2026

Uh oh!

Copilot AI Jan 8, 2026

Uh oh!

Copilot AI Jan 8, 2026

Uh oh!

Copilot AI Jan 8, 2026

Uh oh!

Copilot AI Jan 8, 2026

Uh oh!

Copilot AI Jan 8, 2026

Uh oh!

Copilot AI Jan 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

+[project.optional-dependencies]
+dev = [
+  "pre-commit",
+  "pytest",
+  "twine",
+  "wheel",
+]

	uses: pypa/gh-action-pypi-publish@v1.1.0
	uses: pypa/gh-action-pypi-publish@v1.12.2

	python-version: ["3.9", "3.10", "3.11", "3.12"]
	python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]

	There are several very good templates on GitHub, I prefer to use code we wrote instead of blinding taking the most starred template and having features we don't need. From experience, it's better to keep it simple and general enough for our specific use cases.
	There are several very good templates on GitHub, I prefer to use code we wrote instead of blindly taking the most starred template and having features we don't need. From experience, it's better to keep it simple and general enough for our specific use cases.

General update to follow best practice #15

General update to follow best practice #15

Uh oh!

Conversation

Borda commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Borda commented Jan 8, 2026 •

edited

Loading