Basic¶

This guide covers essential adjustments to the template.

Caution

Keep changes minimal to simplify updates. If your changes relate to a specific section, you may want to consult details documentation.

`pyproject.toml`¶

Most adjustments are made in pyproject.toml, which controls:

Developer Dependencies – Managed in [dependency-groups] (each dependency prefixed by dev).
Tool Settings – Configures tools like ruff ⧉ section [tool.<name-of-tool>].
Developer Commands – Defined under [tool.pdm.scripts] (usually check-<type> or fix-<type>).

Note

Sections are ordered by importance and assumed frequency of change.

Some tools not integrated with pyproject.toml can be configured by editing .pre-commit-config.yaml.

Tip

Non-pyproject.toml configurations are at the beginning of the file.

opentemplate minimizes manual GitHub Actions configuration, allowing modifications through pyproject.toml.

To add or edit actions, edit files in .github/workflows/ folder.

Tip

See GitHub Actions Guide for more information.

For other modifications, check:

Important

Need Help? Search the docs for specific files or directories. If you can’t find what you need, please open an issue ⧉.