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 - NicholasSynovic/template_python: A template repository that Python projects can inherit from to ensure tooling consistency

BranchesTags
Open more actions menu

Latest commit

 

History

30 Commits
30 Commits

Folders and files

NameName
Last commit message
Last commit date
.devcontainer
.devcontainer
 
 
.github
.github
 
 
docs
docs
 
 
src
src
 
 
.editorconfig
.editorconfig
 
 
.gitignore
.gitignore
 
 
.isort.cfg
.isort.cfg
 
 
.markdownlint.json
.markdownlint.json
 
 
.mdformat.toml
.mdformat.toml
 
 
.pre-commit-config.yaml
.pre-commit-config.yaml
 
 
.python-version
.python-version
 
 
.rad.json
.rad.json
 
 
CITATION.cff
CITATION.cff
 
 
Dockerfile
Dockerfile
 
 
LICENSE
LICENSE
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
_config.yml
_config.yml
 
 
pyproject.toml
pyproject.toml
 
 
requirements.txt
requirements.txt
 
 
ruff.toml
ruff.toml
 
 
uv.lock
uv.lock
 
 

Repository files navigation

Python Template Repository

A template repository that Python projects can inherit from to ensure tooling consistency

Table of Contents

  • Python Template Repository
    • Table of Contents
    • About
    • Supported Tooling
      • Visual Studio Code
        • Development Containers
      • Base Template
      • .gitignore
      • requirements.txt
      • Poetry
      • Pre-Commit
        • Hooks
    • Encouraged Tooling
    • Template Structure

About

This is a template repository that is intended to be inherited by other template repositories to ensure consistent common tool deployment Python projects.

This will also support tooling from my template_base repository.

Additionally, while projects can leverage this template or its content, extending this template is encouraged

Supported Tooling

Visual Studio Code

Modifies and extends original template_base

  • Website: https://code.visualstudio.com/
  • File(s):
    • Development Containers: .devcontainer/

Development Containers

  • File: .devcontainer/devcontainer.json
  • Documentation: https://containers.dev/implementors/json_reference
  • Base image: python:3.10-bookworm
  • Extensions:
    • autoDocstring - Python Docstring Generator
    • Python
    • Python Debugger

Base Template

All template_base tooling is supported

  • Documentation: https://github.com/NicholasSynovic/template_base

.gitignore

  • File: .gitignore
  • Documentation: https://git-scm.com/docs/gitignore

requirements.txt

  • File: requirements.txt
  • Documentation: https://pip.pypa.io/en/stable/reference/requirements-file-format/
  • Packages:
    • poetry

Poetry

  • File: pyproject.toml
  • Documentation: https://python-poetry.org/

Pre-Commit

Modifies and extends original template_base

  • Website: https://pre-commit.com/
  • File: .pre-commit-config.yaml

Hooks

  • pyroma
  • black
  • flake8
  • isort
    • Config: .isort.cfg
  • bandit

Encouraged Tooling

For API docs, please consider using one of the following:

  • Sphinx
    • Built-in themes
    • Themes
    • Extensions
  • MkDocs
    • Built-in themes
    • Themes
    • Extensions

Template Structure

Generated with File Tree Generator

📦template_python
 ┣ 📂.devcontainer
 ┃ ┗ 📜devcontainer.json
 ┣ 📂.github
 ┃ ┣ 📂DISCUSSION_TEMPLATE
 ┃ ┃ ┣ 📜implementations.yml
 ┃ ┃ ┗ 📜requests.yml
 ┃ ┣ 📂ISSUE_TEMPLATE
 ┃ ┃ ┗ 📜bug-report.yml
 ┃ ┣ 📂workflows
 ┃ ┃ ┣ 📜jekyll-gh-pages.yml
 ┃ ┃ ┗ 📜pre-commit.yml
 ┃ ┣ 📜CODEOWNERS
 ┃ ┣ 📜CODE_OF_CONDUCT.md
 ┃ ┣ 📜CONTRIBUTING.md
 ┃ ┣ 📜FUNDING.yml
 ┃ ┣ 📜GOVERNANCE.md
 ┃ ┣ 📜SECURITY.md
 ┃ ┗ 📜SUPPORT.md
 ┣ 📂docs
 ┃ ┗ 📜.gitkeep
 ┣ 📂src
 ┃ ┣ 📜__init__.py
 ┃ ┗ 📜main.py
 ┣ 📜.gitignore
 ┣ 📜.isort.cfg
 ┣ 📜.markdownlint.json
 ┣ 📜.mdformat.toml
 ┣ 📜.pre-commit-config.yaml
 ┣ 📜.rad.json
 ┣ 📜CITATION.cff
 ┣ 📜Dockerfile
 ┣ 📜LICENSE
 ┣ 📜Makefile
 ┣ 📜README.md
 ┣ 📜README.md.bk
 ┣ 📜poetry.lock
 ┣ 📜pyproject.toml
 ┗ 📜requirements.txt

About

A template repository that Python projects can inherit from to ensure tooling consistency

Topics

template

Resources

Readme
AGPL-3.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity

Stars

0 stars

Watchers

1 watching

Forks

1 fork
Report repository

Used by

Contributors

Languages

Generated from NicholasSynovic/template_base
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.