busylight-core 0.2.4

Busylight Core Implementation for Humans, presumably like you!

busylight_core - Busylight Core for Humans

Busylight Core Implementation for Humans, presumably like you!

Features

Installation

pip

python3 -m pip install busylight_core

uvx

uvx --from busylight_core busylight_core

uv

uvx pip install busylight_core

Usage

busylight_core --help

Development

This project and it's virtual environment is managed using uv and is configured to support automatic activation of virtual environments using direnv. Development activites such as linting and testing are automated via [Poe The Poet][poethepoet], run poe after cloning this repo.

Clone

git clone https://github.com/JnyJny/busylight_core
cd busylight_core

Allow Direnv optional but recommended

direnv allow

Create a Virtual Environment

uv venv

Install Dependencies

uv sync

Run poe

poe --help

Release Management

This project uses automated release management with GitHub Actions:

Version Bumping

• poe publish_patch - Bump patch version, commit, tag, and push
• poe publish_minor - Bump minor version, commit, tag, and push
• poe publish_major - Bump major version, commit, tag, and push

Release Notes

• poe changelog - Generate changelog since last tag
• poe release-notes - Generate release notes file

Automatic Releases

When you push a version tag (e.g., v1.0.0), the unified GitHub Actions workflow will:

1. Test - Run tests across all supported Python versions and OS combinations
2. Publish - Build and publish to PyPI (only if tests pass)
3. GitHub Release - Create GitHub release with auto-generated notes and artifacts (only if PyPI publish succeeds)

This ensures a complete release pipeline where each step depends on the previous step's success.

MkDocs Documentation

• poe docs-serve - Serve documentation locally
• poe docs-build - Build documentation
• poe docs-deploy - Deploy to GitHub Pages

The template includes MkDocs with material theme and automatic deployment to GitHub Pages.

---