Termage
See the docs for some live examples.
Termage allows you to generate up-to-date, reproducible and real screenshots of Python output while building your documentation. It uses PyTermGUI to create the SVGs, and pre-processes your markdown file into a codefences format.
Installation
Termage is best installed using pip:
$ pip install mkdocs-termage-plugin
This installs the plugin, as well as PyTermGUI as a dependency. By this point you probably should already have mkdocs installed.
Setup
To use the plugin, you should first add it to your mkdocs.yml plugin list:
plugins:
- termage
Latest release
0.6.0 - 2022-08-22
Additions
- Add support for inserting SVGs inline, without writing files
Refactors
- Unify the codeblock-formatting API under
execution.format_codeblock - Rewrite & refactor most of the plugin to be more maintainable
- Refactor the Python API so that the
termagefunction is called by the CLI, not the other way around.
Read the full changelog here.
Metadata
Release files for Termage 0.6.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 |
|---|---|---|---|---|
| termage-0.6.0.tar.gz | 3.0 MB | Without provenance | Details for termage-0.6.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| termage-0.6.0-py3-none-any.whl | Python 3 | none | any | Details for termage-0.6.0-py3-none-any.whl |
Total release size: 3.0 MB
Release files / termage-0.6.0.tar.gz
| Download URL | termage-0.6.0.tar.gz |
|---|---|
| Size | 3.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2a7d11c22002d0cf4f53df41527b685e5529c8c6757a05cab9ed9df17808dc8e
|
|
BLAKE2b-256 checksum How to use checksums |
b8521603d31f9a837e5bd6759dcb1c8037a8b6eeb5146221b90abe18bd0a8179
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.22.0
|
Release files / termage-0.6.0-py3-none-any.whl
| Download URL | termage-0.6.0-py3-none-any.whl |
|---|---|
| Size | 9.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
67f3cce369ef9ea2fea2fdba15858c73e232bc27b1ed15000ff1337850774efd
|
|
BLAKE2b-256 checksum How to use checksums |
e18797a1da06a275209fc445052a3733a6523606b7eee97ab237d20f6fd58bde
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.22.0
|
Security for Termage 0.6.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.