block-style-cms-sdk

Python SDK for Block Style CMS.

Install

pip install block-style-cms-sdk
# or: uv add block-style-cms-sdk

Auth

Create an API token in the CMS admin UI. Pass it when constructing the client:

• Header: x-api-key: <token> (default), or
• Authorization: Bearer <token>

Publish from Markdown

1. Collect relative images from markdown (e.g. ./assets/foo.png)
2. Resolve files under the required assetsDir
3. Upload via POST /api/m/images
4. Rewrite paths to /images/{filename}
5. Submit via POST /api/m/articles/from-markdown

from block_style_cms_sdk import BlockStyleCmsClient

client = BlockStyleCmsClient(
    base_url="https://cms.example.com",
    api_key="bsc_...",
)

client.articles.publish_from_markdown(
    title="Hello",
    slug="hello-article-slug",
    summary="A short summary of at least ten chars",
    tags=["demo"],
    language="en-US",
    md_file="./posts/hello.md",
    assets_dir="./posts/assets",
    published=False,
)

Content metadata

Before publishing, discover site configuration:

• GET /api/m/locales — site-supported article languages (deployment-specific)
• GET /api/m/channels — site channels from CMS settings

locales = client.content.list_locales()
channels = client.content.list_channels()

List filter published is a status token — "published" | "draft" | "all" — not a boolean. Do not pass "true" / "false".

client.articles.list(published="published", page_size=20)

Develop

From packages/python:

uv sync --extra dev
uv run ruff check .
uv run ruff format .

Remote API check with the shared sample fixture (samples/):

cd packages/python
BSC_BASE_URL=https://your-cms.example.com \
BSC_API_KEY=bsc_... \
uv run python tests/publish_sample_article.py

Release

1. Bump version in pyproject.toml.
2. Tag py-vX.Y.Z, push, and Publish a GitHub Release for that tag.
3. GitHub Actions uploads to PyPI via Trusted Publishing (OIDC; no PYPI_TOKEN secret).

Example: version 0.0.3 → tag py-v0.0.3 → GitHub Release → PyPI.