Skip to main content
Ctrl+K
Logo image

python3-pip-skeleton-cli

Site Navigation

  • User Guide
  • Developer Guide
  • Release Notes

Site Navigation

  • User Guide
  • Developer Guide
  • Release Notes

Section Navigation

Tutorials

  • Installation
  • Creating a new repo from the skeleton

How-to Guides

  • Creating a new skeleton fork
  • Run in a container
  • How to adopt the skeleton in an existing repo
  • How to update to the latest skeleton structure
  • How to embed Excalidraw diagrams
  • Creating a PyPI Token

Explanations

  • Skeleton Project Structure
  • Why Use a Skeleton Structure?
  • Architectural Decision Records
    • 1. Record architecture decisions
    • 3. Standard documentation structure
    • 4. Use a source directory
    • 5. Use pyproject.toml
    • 6. Use setuptools_scm
    • 7. Installing developer environment
    • 8. Use tox and pre-commit
    • 9. Sphinx theme
    • 10. Include vscode settings
    • 11. Pinning requirements
    • 12. Use containers

Reference

  • API
  • Index
  • User Guide
  • Architectural Decision Records

Architectural Decision Records#

We record major architectural decisions in Architecture Decision Records (ADRs), as described by Michael Nygard. Below is the list of our current ADRs.

  • 1. Record architecture decisions
  • 3. Standard documentation structure
  • 4. Use a source directory
  • 5. Use pyproject.toml
  • 6. Use setuptools_scm
  • 7. Installing developer environment
  • 8. Use tox and pre-commit
  • 9. Sphinx theme
  • 10. Include vscode settings
  • 11. Pinning requirements
  • 12. Use containers

previous

Why Use a Skeleton Structure?

next

1. Record architecture decisions

Edit on GitHub
Show Source

Built with the PyData Sphinx Theme 0.13.3.