Description of the project/package. Make it super easy for people to understand what it does. Add links to external resources like Notion, SOWs, etc.if needed.
Bullet form list of the most important features of the project/package.
How to use package_name. Include examples and code snippets.
package_name/: Contains the package logictests/: Contains tests for the packageexploration/: Contains exploratory code for testing new features
This package has been created with pymc-labs/project-starter. It features:
- 📦
pixifor dependency and environment management. - 🧹
pre-commitfor formatting, spellcheck, etc. If everyone uses the same standard formatting, then PRs won't have flaky formatting updates that distract from the actual contribution. Reviewing code will be much easier. - 🏷️
beartypefor runtime type checking. If you know what's going in and out of functions just by reading the code, then it's easier to debug. And if these types are even enforced at runtime with tools likebeartype, then there's a whole class of bugs that can never enter your code. - 🧪
pytestfor testing. Meanwhile, withbeartypehandling type checks, tests do not have to assert types, and can merely focus on whether the actual logic works. - 🔄 Github Actions for running the pre-commit checks on each PR, automated testing and dependency management (dependabot).
- Python 3.11 or higher
- Pixi package manager
- Run
pixi installto install the dependencies. - Run
pixi r testto run the tests.