Skip to content

update readme

update readme #31

Workflow file for this run

name: CI
on:
push:
branches:
- main
pull_request:
branches:
- main
permissions:
contents: read
checks: write
jobs:
test:
name: Test
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v6
- name: Setup Python
uses: actions/setup-python@v6
with:
python-version-file: "pyproject.toml"
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
enable-cache: true
- name: Setup project
run: uv sync --all-extras --dev
- name: Run tests
run: uv run pytest --junit-xml=pytest.xml
env:
API_KEY: ${{ secrets.LPDB_API_KEY }}
- name: Publish Test Results
if: ${{ always() }}
uses: mikepenz/action-junit-report@v6
with:
report_paths: "**/*.xml"
annotate_only: ${{ github.event_name == 'pull_request' }}
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v6
- name: Setup Python
uses: actions/setup-python@v6
with:
python-version-file: "pyproject.toml"
- name: Check styling
uses: psf/black@stable