snakemd-stubs
PEP 561 type stubs for SnakeMD, the Markdown-generation library for Python.
Supported versions
The first release targets the SnakeMD 2.4 API:
- first tag:
v2.4.1.0 - runtime dependency:
SnakeMD>=2.4.0,<2.5.0 - Python:
>=3.10,<4.0
SnakeMD 2.4.0 and 2.4.1 expose the same public API. SnakeMD 2.3.x is
intentionally outside this package's range because 2.4 introduced
Alert, Checklist, and the Inline.breakline() API, while also changing
list internals.
The version format is RUNTIME_MAJOR.RUNTIME_MINOR.RUNTIME_PATCH.STUB_REV.
The first three components identify the runtime API line; the final component
increments when the stubs are corrected or expanded without changing the
supported SnakeMD runtime range.
Each release line has one runtime dependency range. For example, a future
2.3.x.y line would require SnakeMD>=2.3,<2.4, while a 2.5.x.y line would
require SnakeMD>=2.5,<2.6. The latest API line is maintained on main; an
older line receives a release/<major>.<minor> branch only when it needs a
correction.
Versions are derived from Git tags with setuptools-scm. Release tags use the
form vRUNTIME_MAJOR.RUNTIME_MINOR.RUNTIME_PATCH.STUB_REV; do not edit a
version string in pyproject.toml.
Installation
python -m pip install snakemd-stubs
The runtime package is declared as a dependency, as recommended for a
standalone PEP 561 stub distribution. The stubs are used automatically by
type checkers after installation; application imports remain import snakemd.
Scope
The declarations cover the public classes and convenience methods exported by
SnakeMD's snakemd, snakemd.document, snakemd.elements, and
snakemd.templates modules. They are based on the existing declarations in
GitHub-Org-Observer/typings/snakemd
and checked against the published SnakeMD 2.4.0 and 2.4.1 source archives.
Releasing
CI validates formatting, type checking, runtime/stub compatibility, and both
PyPI artifacts. To release, commit the changes, create a matching version tag
(for example, v2.4.1.0), and push the tag. The publish workflow uses PyPI
Trusted Publishing; configure the PyPI project to trust this repository's
publish.yml workflow before pushing the first release tag.
License
The stubs are distributed under the MIT License. See LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for snakemd-stubs 2.4.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| snakemd_stubs-2.4.1.0.tar.gz | 7.7 kB | Without provenance | Details for snakemd_stubs-2.4.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| snakemd_stubs-2.4.1.0-py3-none-any.whl | Python 3 | none | any | Details for snakemd_stubs-2.4.1.0-py3-none-any.whl |
Total release size: 13.9 kB
Release files / snakemd_stubs-2.4.1.0.tar.gz
| Download URL | snakemd_stubs-2.4.1.0.tar.gz |
|---|---|
| Size | 7.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dc5b298934379c063015795271dfb2f2d05cb6195c35db68c220ecfbf53f8402
|
|
BLAKE2b-256 checksum How to use checksums |
320cef39f1ea9f505518cd2f8ecc98576906ac17e5eca817b266a2142fef16b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Release files / snakemd_stubs-2.4.1.0-py3-none-any.whl
| Download URL | snakemd_stubs-2.4.1.0-py3-none-any.whl |
|---|---|
| Size | 6.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
02b299cc85b59de64a5af7d64db628e65602f39bc3c92dfa0b6fb01d5e4d821e
|
|
BLAKE2b-256 checksum How to use checksums |
51952c2a98227cb15e50613ee4c1bdb116ea11c6c364f3f8edc2472e951bbaa6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Security for snakemd-stubs 2.4.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
