Python Template Repository

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

Table of Contents

Python Template Repository

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:

Base Template

All template_base tooling is supported

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

Pre-Commit

Modifies and extends original template_base

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

Hooks

Encouraged Tooling

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

Sphinx
MkDocs

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

License

NicholasSynovic/template_python

ErrorLooks like something went wrong!

About

Topics

Resources

License

Code of conduct

Security policy

Uh oh!

Stars

Watchers

Forks

Uh oh!

Languages

Error
Looks like something went wrong!