Tip
This Python package was generated from the
template-python-package
Seedcase template 🎉
.github/
: Contains GitHub-specific files, such as issue and pull request templates, workflows, dependabot configuration, pull request templates, and a CODEOWNERS file.tools/vulture-allowlist.py
: List of variables that shouldn’t be flagged by Vulture as unused.tools/get-contributors.sh
: Script to get list of project contributors.tests/
: Test files for the package.src/
: Source code for the package.docs/
: Documentation about using and developing the Python package._renderer.py
: Customquartodoc
renderer.pytest.ini
: Pytest configuration file.mypy.ini
:mypy
configuration file for type checking Python code..copier-answers.yml
: Contains the answers you gave when copying the project from the template. You should not modify this file directly..cz.toml
: Commitizen configuration file for managing versions and changelogs..pre-commit-config.yaml
: Pre-commit configuration file for managing and running checks before each commit..typos.toml
: typos spell checker configuration file.justfile
:just
configuration file for scripting project tasks..editorconfig
: Editor configuration file for EditorConfig to maintain consistent coding styles across different editors and IDEs.CHANGELOG.md
: Changelog file for tracking changes in the project.CITATION.cff
: Structured citation metadata for your project.CONTRIBUTING.md
: Guidelines for contributing to the project._metadata.yml
: Quarto metadata file for the website, including information about the project, such as the titles and GitHub names.pyproject.toml
: Main Python project configuration file defining metadata and dependencies._quarto.yml
: Quarto configuration file for the website, including settings for the website, such as the theme, navigation, and other options.ruff.toml
: Ruff configuration file for linting and formatting Python code.uv.lock
: Lockfile used byuv
to record exact versions of installed dependencies.
Check out our contributing document for information on how to contribute to the project, including how to set up your development environment.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
This project is licensed under the MIT License.
For a list of changes, see our changelog page.