LINCC Frameworks Python Project Template
v2.0.2

Using the Template

  • Getting Started
  • Create a new templated project
  • or, Hydrate an un-templated project
  • Configure a templated project
  • Update a templated project
  • Contribute to the template
  • Any questions? Contact us

Template Options

  • 1. Simple or custom installation
  • 2. Name of your project
  • 3. Python package name
  • 4. Github organization name
  • 5. Name of the code author
  • 6. Email address
  • 7. License
  • 8. Versions of Python
  • 9. Linters/Reformatters
  • 10. Failure notifications
  • 11. Static type checking
  • 12. Example module code
  • 13. Sphinx and autoapi directory
  • 14. Rendered notebooks
  • 15. Benchmarking

Best Practices

  • Overview
  • Pipx
  • Pre-Commit
  • Code Style: Linters, Auto-Formatters
  • Continuous Integration
  • Python Namespace Projects
  • Issue and Pull Request Templates
  • Sphinx: ReadTheDocs, AutoAPI
  • Publishing Your Package: PyPI, Conda
LINCC Frameworks Python Project Template
  • Search

© Copyright 2023, LINCC Frameworks. Revision e1548395.

Built with Sphinx using a theme provided by Read the Docs.