dsp-toolkit

• dsp-toolkit
  • Overview
  • Installation
  • Quickstart
  • Features
  • CLI Usage
  • Extending & Overriding
  • Development Workflow
  • CI/CD & Release
  • Troubleshooting & FAQ
  • Local Development & Testing in Another App
    • 1. Editable Install (Recommended)
    • 2. Build and Install the Package
    • 3. Local Path Dependency in pyproject.toml

Overview

This library is a toolkit for shared code between apps to try and make them consistent.

Installation

poetry add dsp-toolkit

NOTE: Requires Python >=3.12,<4.0.

Quickstart

from dsp_toolkit.logging import logger

logger.info("I am a logging statement")

Features

• cli.py: Reusable CLI for test, lint, release.
• logging.py: Centralized logging config.
• env.py: Environment variable management.
• plugins/: Custom flake8 plugins.

CLI Usage

• poetry run test [args]: Run tests with optional args.
• poetry run lint [args]: Run linting with optional args.
• poetry run release: Run semantic-release for publishing.

Extending & Overriding

• Subclass toolkit modules in your app for custom behavior.

• Extend CLI commands:

  • Create your own cli.py in your app (e.g., src/my_app/cli.py).
  • Import and reuse commands from dsp_toolkit.cli, then add or override as needed:

    from dsp_toolkit.cli import test, lint_and_format, release
    
    def custom_command():
        print("This is my custom command!")
    
    # You can add an argparse entry point or use Poetry scripts to expose your custom commands.
    

  • In your pyproject.toml, add a Poetry script for your CLI:

    [tool.poetry.scripts]
    test = "my_app.cli:test"
    custom = "my_app.cli:custom_command"
    

• Register additional plugins in your app's config:

  • For Flake8 plugins, add them to your app's setup.cfg or register via entry_points in pyproject.toml:

    [flake8:local-plugins]
    extension =
        MYPLUG = my_app.plugins.my_plugin:MyPlugin
    

  • For pip-installable plugins, add them to your app's dependencies and Flake8 will auto-discover them.
  • For custom plugin registration, see Flake8 documentation: https://flake8.pycqa.org/en/latest/user/configuration.html#local-plugins

Development Workflow

• Run tests: poetry run test
• Lint: poetry run lint
• Build: poetry build

CI/CD & Release

Automated via GitHub Actions and semantic-release. See .github/workflows/ci.yml and .github/workflows/release.yml for details.

Troubleshooting & FAQ

• If you encounter dependency issues, check your Python version and Poetry config.
• For local testing, see the section below.

Local Development & Testing in Another App

You can test dsp-toolkit in another app before releasing to PyPI:

1. Editable Install (Recommended)

From your app directory:

poetry add ../path/to/dsp-toolkit --editable

or with pip:

pip install -e ../path/to/dsp-toolkit

2. Build and Install the Package

Build your library:

poetry build

Then install the wheel or sdist in your app (Recommended):

poetry add ../path/to/dsp-toolkit/dist/dsp_toolkit-0.1.0-py3-none-any.whl

or

pip install ../path/to/dsp-toolkit/dist/dsp_toolkit-0.1.0-py3-none-any.whl

3. Local Path Dependency in pyproject.toml

In your app’s pyproject.toml:

[tool.poetry.dependencies]
dsp-toolkit = { path = "../path/to/dsp-toolkit", develop = true }

Then run:

poetry install