songbirdcore 0.1.2

core low level api for songbird

songbirdcore 🐦

Low-level package with common code used across songbird's cli and api.

See:

• songbirdcli
• songbirdapi

Documentation

songbirdcore's documentation may be found here

Requirements

• Python version >= 3.11

Installation

To install, run

pip install songbirdcore

To install the latest development version from test-pypi run

    python3 -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ songbirdcore

Development

Once you have clone the repository, run

export ENV=dev
make setup
source venv/bin/activate
make requirements

This configures a virtual environment locally. You can then run tests by performing the steps below.

Updating Requirements

Updating the requirements for this package may be done through

make update-requirements
make requirements

Tests

Configure your vscode debugger by creating a .vscode/settings.json file with the following contents:

{
    "python.testing.pytestArgs": [
        "tests"
    ],
    "python.testing.unittestEnabled": false,
    "python.testing.pytestEnabled": true,
}