treetops 0.0.3

A simple Python package template

Treetops

A simple Python package template for MLOps abstraction.

Installation

Install the latest stable version from PyPI:

pip install treetops

Or install the development version from source:

git clone https://github.com/tylerlanigan/treetops.git
cd treetops
# Installs package dependencies, but not dev tools
pip install .

Usage

from treetops.example import hello

# Greet the world
print(hello())
# Output: Hello, World!

Development

Setup Development Environment

The best practice is to use pyenv to manage your Python versions and venv to isolate your project dependencies.

Prerequisites

• pyenv installed (for managing Python versions)
• Git installed

Step-by-Step Setup

Clone the repository:

git clone https://github.com/tylerlanigan/treetops.git
cd treetops

Install and activate the required Python version:

# Install the Python version specified in .python-version (e.g., 3.11.9)
# This step requires pyenv
pyenv install 

# Set the local Python version for this project's directory
pyenv local 

Create and activate the standardized virtual environment:

# Create the virtual environment folder named .venv
python -m venv .venv

# Activate the virtual environment
source .venv/bin/activate 

Install the package in editable mode with development dependencies:

# Ensure pip is up-to-date
python -m pip install --upgrade pip

# Install the package in editable mode (-e) along with all [dev] dependencies (pytest, ruff, etc.)
pip install -e ".[dev]"

Working with the Editable Install

Once installed with pip install -e .[dev], any changes you make to the source code will be immediately available without needing to reinstall.

Run Tests: Execute the test suite using the development dependency pytest.

pytest tests/

Run Linter/Formatter: Use the ruff tool for fast code quality checks and automatic formatting.

# Check and apply automatic fixes (linting, import sorting)
ruff check --fix . 

# Apply standard formatting (like Black)
ruff format .

🚀 Publishing a New Release

The Treetops package uses secure, token-less GitHub Actions Trusted Publishing (OIDC) for deployment. Releases are only published to PyPI when a version tag (v*) is pushed.

Follow this workflow to release a new version:

First tag the version (using 0.0.3 as an example)

git tag v0.0.3

Push the tag to GitHub. This triggers the automated CI/CD workflow, which builds and publishes the package to PyPI.

git push origin v0.0.3 

License

MIT License - see LICENSE file for details.