GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - jnfire/python-module-template: An up-to-date template for Python packages. Includes `pyproject.toml`, `src` layout, `pytest`, `ruff`, `pre-commit`, and a `Makefile` for a smooth development workflow.

BranchesTags
Open more actions menu

Latest commit

 

History

12 Commits
12 Commits

Folders and files

NameName
Last commit message
Last commit date
docs
docs
 
 
src/module_name
src/module_name
 
 
tests
tests
 
 
CHANGELOG.md
CHANGELOG.md
 
 
LICENSE
LICENSE
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
VERSION.txt
VERSION.txt
 
 
pyproject.toml
pyproject.toml
 
 

Repository files navigation

Python Module Template

A template for creating professional, modern, and installable Python packages.

This template is configured with current best practices to provide a robust and developer-friendly starting point. It's designed to be didactic, easy to use, and highly configurable.

Features

  • Single Configuration: pyproject.toml as the single source of truth (PEP 621).
  • Robust Structure: src layout to prevent common import errors.
  • Modern Testing: pytest for writing simple and powerful tests.
  • Automated Quality: Code linting and formatting with ruff and black.
  • Pre-commit Hooks: Automatic quality checks before every commit with pre-commit.
  • Simplified Versioning: Semantic versioning with bump-my-version.
  • Easy Task Management: A Makefile with shortcuts for common development tasks (install, test, build, etc.).

Getting Started

For detailed instructions on how to use this template, please choose your preferred language:

  • English
  • Español

Quick Setup

  1. Clone the repository:

    git clone <this-repo-url> my-new-project
    cd my-new-project
  2. Install the development environment: This command creates a virtual environment, installs all dependencies, and sets up pre-commit hooks.

    make install
  3. Start coding! Your source code lives in src/module_name. Follow the detailed instructions linked above to rename the package and configure pyproject.toml.

About

An up-to-date template for Python packages. Includes `pyproject.toml`, `src` layout, `pytest`, `ruff`, `pre-commit`, and a `Makefile` for a smooth development workflow.

Topics

boilerplatemakefilepackagingpre-commitpyproject-tomlpytestpythonruffsetuptoolssrc-layouttemplate

Resources

Readme
License
Activity

Stars

1 star

Watchers

0 watching

Forks

1 fork
Report repository

Releases

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.