Skip to content

Writing Python Libraries

Work in Progress

This chapter is a placeholder and will be expanded with detailed best practices for writing Python libraries.

Overview

This chapter will cover best practices for developing Python libraries within the ForeSITE group.

Topics to be Covered

  • Project structure and packaging
  • Dependency management with uv/pip
  • Documentation with Sphinx or MkDocs
  • Testing with pytest
  • Type hints and code quality
  • Publishing to PyPI
  • Continuous integration and deployment

This content will be expanded in future updates.