API Reference

User configuration management for uv-start.

Provides a fallback chain for author info: config file -> git config -> defaults. Config is stored at ~/.config/uv-start/config.toml.

class uv_start.config.UserConfig(author_name, author_email)

Bases: object

User configuration for project scaffolding.

author_email: str

author_name: str

uv_start.config.clean_env()

Return a minimal environment safe for uv/git subprocesses.

Only passes through variables needed for process execution, explicitly excluding secrets and tokens that may be exported in the shell session.

Return type:

dict[str, str]

uv_start.config.load_config()

Load user config with fallback chain: config file -> git -> defaults.

Return type:

UserConfig

uv_start.config.save_config(name, email)

Write user config to ~/.config/uv-start/config.toml.

Return type:

None

class uv_start.router.CommandDispatcher(args, original_cwd)

Bases: object

Dispatch commands based on argument pattern

args: Namespace

check_dir_exists()

Return type:

None

dispatch()

Route to appropriate command handler based on argument pattern

Return type:

None

original_cwd: Path

Module to copy the README.md, LICENCE, .gitignore and .pre-commit-config.yaml files to the build directory and add author information.

uv_start.parse_docs.parse_docs(args, project_dir)

Parse the README.md file and update the content with project information.

Return type:

None

uv_start.parse_docs.parse_docs_data(args, project_dir)

Set up template files for a data analysis project.

Copies .gitignore, .env.example, the hhlab matplotlib style, and a starter sample.ipynb into the project root. No src/ structure is created.

Return type:

None

uv_start.parse_docs.parse_docs_napari(args, project_dir)

Set up template files for a napari plugin project.

Runs the standard project template setup, then copies napari.yaml and a hello-world widget into src/<module>/, and appends the napari manifest entry point to pyproject.toml.

Return type:

None