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!

If you find it useful, or have any questions or concerns when using the template, please Contact us

Important

These instructions assume you are using copier version 9.1 or newer. Some features may not be available in older versions.

Using the Template

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

Best Practices

• Overview
• Continuous Integration Benchmarking
• Continuous Integration Pre-Commit
• Continuous Integration Testing
• Code Coverage
• Git Large File Support
• Issue and Pull Request Templates
• Code Style
• Python namespace project
• pipx
• Pre-Commit
• PyPI
• Conda
• Unit testing
• pytest-timeout
• Sphinx - ReadTheDocs and AutoAPI