Setup & Dependency Check¶

Run the following command to check if the base dependencies are installed.

make check

Setup Development Environment¶

Project requires Python 3.10+ (which is also specified inside .python-version file) There are two options for setting up the development environment:

Using uv:
Using pip:

It depends on the tool you choose, but both offer a convenient way to install the package in editable mode with development dependencies. UV is recommended as it offers much greater speed and a lot of features and tools out of the box.

Using uv:¶

# This command creates a live development installation that allows you to modify the code without reinstalling while also installing additional development tools (like pytest, mypy, etc.) specified in your project's dev dependencies.
uv pip install --editable ".[dev]"

# Format the code
uvx ruff format py_launch_blueprint/

# Run linter
uvx ruff check py_launch_blueprint/

# Run type checker
uvx  --with-editable . mypy py_launch_blueprint/

# Run tests
uvx --with-editable . pytest

# Run tests with coverage
uvx --with pytest-cov --with-editable . pytest --cov=py_launch_blueprint.projects --cov-report=term-missing

# Run command
uvx --with-editable .  --from py_launch_blueprint py-projects

(Optional) Pre-Commit Hooks with uv¶

# Setup Pre-Commit Hook
uvx --with-editable . pre-commit install

#Run all pre-Commit Hooks
uvx pre-commit run --all-files

Using pip:¶

# Create and activate a virtual environment if needed
python3 -m venv .venv
source .venv/bin/activate  # On Unix/macOS
.venv\Scripts\activate  # On Windows

# Install the package in editable mode with development dependencies
pip install --editable ".[dev]"

# Run development tools directly (no need for 'uv pip run')
ruff format py_launch_blueprint/
ruff check py_launch_blueprint/
mypy py_launch_blueprint/
pytest --cov=py_launch_blueprint.projects --cov-report=term-missing

# Check the installed package cli tool version
py-projects --version

(Optional) Pre-Commit Hooks with pip¶

# Setup Pre-Commit Hook
pre-commit install

#Run all pre-Commit Hooks
pre-commit run --all-files

Customization for New Projects¶

When using this workflow as a template for a new project, update the following:

Project Name: Replace py_launch_blueprint with your package name in the version verification step:

PY_VERSION=$(uv run python -c "import your_package_name; print(your_package_name.__version__)")

Python Version: Update the Python version to match your project’s requirements:
```
with:
  python-version: "3.11" # Change to your required version
```