Skip to main content

inkling (Python)

Reveal ASCII art as a progress indicator, from Python. Same engine as the Rust crate, exposed as a tiny extension built with PyO3. It installs as inkling-loader and imports as inkling.

Inkling revealing ASCII art in rainbow as a task runs

pip install inkling-loader

Determinate, like tqdm but the bar is a drawing:

from inkling import Loader

with Loader(total=len(items), rainbow=True) as bar:
    for it in items:
        work(it)
        bar.inc()

A download, setting the position as bytes arrive:

bar = Loader(total=content_length, art_path="dragon.txt")
for chunk in response:
    file.write(chunk)
    bar.inc(len(chunk))
bar.finish()

Log while the reveal is live. println puts a line above the art and redraws beneath it, so nothing lands in the middle of the drawing:

with Loader(total=len(files), geodesic=True) as bar:
    for path in files:
        if check(path):
            bar.println(f"ok {path}")
        bar.inc()

The package ships py.typed and full type stubs, so editors and type checkers see the whole surface rather than an opaque native module.

Method Effect
inc(delta=1) advance the position
set(pos) set the absolute position
set_length(total) change the total
set_message(text) caption beneath the art
println(line) print a line above the live reveal
finish() / finish_and_clear() finish, keeping or erasing the art
Property Value
position, length current and total units of work
elapsed seconds since the loader started
rate average units per second
eta estimated seconds remaining, or None

Constructor keywords: total, art, art_path, ordering ("auto", "geodesic", "scanline", "reading", "ltr", "rtl"), the shorthands rainbow, geodesic and reading, plus light, color, head, body, feather, easing, start, bridge, and message.

The inkling family

This is the Python package. The same engine ships five ways:

  • inkling-loader on PyPI (this package), for Python. pip install inkling-loader, import as inkling.
  • inkling-loader on crates.io, the Rust library. cargo add inkling-loader.
  • inkling-cli, the inkling command, to drive a reveal from any language through a pipe. cargo install inkling-cli.
  • inkling-loader on npm, the Node addon. npm install inkling-loader.
  • inkling-wasm on npm, the WebAssembly build for the browser.

Building from source

pip install maturin
maturin develop            # build and install into the current venv
maturin build --release    # produce a wheel in target/wheels

Built from the inkling Rust core. License: MIT.

Metadata

Release files for inkling-loader 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for inkling-loader 0.2.2
File Size Uploaded Provenance Actions
inkling_loader-0.2.2.tar.gz 57.7 kB With provenance Details for inkling_loader-0.2.2.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for inkling-loader 0.2.2
File Actions
inkling_loader-0.2.2-cp38-abi3-win_amd64.whl CPython 3.8 abi3 Windows x86-64 Details for inkling_loader-0.2.2-cp38-abi3-win_amd64.whl
inkling_loader-0.2.2-cp38-abi3-musllinux_1_2_x86_64.whl CPython 3.8 abi3 Linux musl 1.2+ x86-64 Details for inkling_loader-0.2.2-cp38-abi3-musllinux_1_2_x86_64.whl
inkling_loader-0.2.2-cp38-abi3-musllinux_1_2_aarch64.whl CPython 3.8 abi3 Linux musl 1.2+ ARM64 Details for inkling_loader-0.2.2-cp38-abi3-musllinux_1_2_aarch64.whl
inkling_loader-0.2.2-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.8 abi3 Linux glibc 2.17+ x86-64 Details for inkling_loader-0.2.2-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
inkling_loader-0.2.2-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl CPython 3.8 abi3 Linux glibc 2.17+ ARM64 Details for inkling_loader-0.2.2-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
inkling_loader-0.2.2-cp38-abi3-macosx_11_0_arm64.whl CPython 3.8 abi3 macOS 11.0+ ARM64 Details for inkling_loader-0.2.2-cp38-abi3-macosx_11_0_arm64.whl
inkling_loader-0.2.2-cp38-abi3-macosx_10_12_x86_64.whl CPython 3.8 abi3 macOS 10.12+ x86-64 Details for inkling_loader-0.2.2-cp38-abi3-macosx_10_12_x86_64.whl

Total release size: 2.9 MB

Release files / inkling_loader-0.2.2.tar.gz

Download URL inkling_loader-0.2.2.tar.gz
Size 57.7 kB
Tags Source
SHA-256 checksum
How to use checksums
e633ae7621f853fd4105163475d7db4ba04228b3c472da940fb0d6a5f640dad3
BLAKE2b-256 checksum
How to use checksums
aa39844e9aed0f1d715e3e4ae3ad0d817dac32406c92fc67697a08d54ee1cb46
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Release files / inkling_loader-0.2.2-cp38-abi3-win_amd64.whl

Download URL inkling_loader-0.2.2-cp38-abi3-win_amd64.whl
Size 232.9 kB
Tags CPython 3.8 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
96ceb7b5b5f8ec2a2a19265131b1b000802b65d7fcaeb5c1cf2b8491b2e9055f
BLAKE2b-256 checksum
How to use checksums
2e5344425ccff09bce9b1db1b3d8b2d46addcdfaf5a3a20bd3a3f0e47183f3b1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Release files / inkling_loader-0.2.2-cp38-abi3-musllinux_1_2_x86_64.whl

Download URL inkling_loader-0.2.2-cp38-abi3-musllinux_1_2_x86_64.whl
Size 603.2 kB
Tags CPython 3.8 Linux musl 1.2+ x86-64 abi3
SHA-256 checksum
How to use checksums
a9dbb5231efa0d8c846b08e0adb60c4f386f463d019f8d2a572e1a2b4aad8872
BLAKE2b-256 checksum
How to use checksums
d05b9a4c4fb25a28bf3b61fc312c35e1a07441068ffb9759de8e38fcc470dde0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Release files / inkling_loader-0.2.2-cp38-abi3-musllinux_1_2_aarch64.whl

Download URL inkling_loader-0.2.2-cp38-abi3-musllinux_1_2_aarch64.whl
Size 565.5 kB
Tags CPython 3.8 Linux musl 1.2+ ARM64 abi3
SHA-256 checksum
How to use checksums
2dcb5042896bf2ae526e4662ce0689fb91a4546547d5fec6294292235545c3d7
BLAKE2b-256 checksum
How to use checksums
70dfeb36302a2445db03a05d8b2951c8798e5592488a136c176900c6f532703c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Release files / inkling_loader-0.2.2-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL inkling_loader-0.2.2-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 397.1 kB
Tags CPython 3.8 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
e640da203bd613b2d174a7fd792fa3d3f7992ac9c41886f835a8cc576879f282
BLAKE2b-256 checksum
How to use checksums
5b6d518af1f9b9eaf42f80545e42f54def987bf48a550db9f31cb94738339e37
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Release files / inkling_loader-0.2.2-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL inkling_loader-0.2.2-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 389.0 kB
Tags CPython 3.8 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
9b9ae7d3c741f7c68cc923fb313eac3d089218a50a86c352ba3adf4ffbd29a66
BLAKE2b-256 checksum
How to use checksums
02ce0a7c70ebbe8f1e6f45e0a3e65367199301117e6bd18633fdfe140ab88205
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Release files / inkling_loader-0.2.2-cp38-abi3-macosx_11_0_arm64.whl

Download URL inkling_loader-0.2.2-cp38-abi3-macosx_11_0_arm64.whl
Size 339.7 kB
Tags CPython 3.8 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
5afb80162bc12a5b9e3d18d0bd00677c9af231a20811498c62cb62e33d76bc7b
BLAKE2b-256 checksum
How to use checksums
c0de8e2adb0482971d563194cf84b9b55d47216aa8963705311e7a56b230c773
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Release files / inkling_loader-0.2.2-cp38-abi3-macosx_10_12_x86_64.whl

Download URL inkling_loader-0.2.2-cp38-abi3-macosx_10_12_x86_64.whl
Size 348.1 kB
Tags CPython 3.8 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
a81a6ff9a3101aed5ec9cd1eae61947dcc98cb3f1b358d184fa8ae449265836d
BLAKE2b-256 checksum
How to use checksums
a87ead70b44c1cdfdd35442e026761589b2d0dcde2ad5e7b87871672f9753456
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Security for inkling-loader 0.2.2

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.

Full provenance

All 8 files in this release have been uploaded with provenance metadata.

Select from 8 files

Attestation for inkling_loader-0.2.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page