LINCC Frameworks Python Project Template

This project template codifies LINCC Framework’s best practices for python code organization, testing, documentation, and automation. It is meant to help python projects get started quickly and allow the user to focus on writing code.

We think it’s really neat, and we hope you do to!

Using the Template

• Getting Started
• Starting a new project
• Updating a project
• Incorporating the template into a prior project
• Contributing to the template

Best Practices

• Overview
• Continuous Integration Testing
• Code Coverage
• Git Large File Support
• Linting
• pipx
• Pre-Commit
• PyPI
• Sphinx - ReadTheDocs and AutoAPI