asynkio 0.0.5

Tokio-like functionality for Python

asynkio - README

Tokio-like functionality for Python

Table of contents

• Introduction
• Installation & Usage
• Components
• Examples
• Project Information
  • Where to get help
  • Contribution guidelines
  • Dependencies
    • Efferent (fan-out)
      • Development Dependencies
    • Afferent (fan-in)
  • Related projects
  • License

Introduction

asynkio - a portmanteau of asyncio and Tokio, pronounced "ay sink ee-oh" - is a small, simple Python library that provides some of the features of the Rust Tokio library's features, such as Duration, Instant, and Interval.

Installation & Usage

Install via pip or pip3, as in:

$ pip3 install asynkio

Use via import:

from asynkio import (
    Duration,
    Instant,
    Interval,
    MissedTickBehaviour,
)

or:

from asynkio.time import (
    Duration,
    Instant,
    Interval,
    MissedTickBehaviour,
)

MissedTickBehavior (US spelling) is also exported as an alias for MissedTickBehaviour.

Components

Symbol	Description
Duration	Elapsed time, in nanoseconds (Tokio-like)
Instant	Point in time, as nanoseconds since the epoch
Interval	Async periodic timer with missed-tick policy
MissedTickBehaviour	Missed-tick policy (BURST, DELAY, SKIP)

Examples

Examples are provided in the examples/ directory. See EXAMPLES.md for a summary of each script.

Run a script with, for example:

$ uv sync
$ uv run python examples/interval_skip.py

Project Information

Where to get help

GitHub Page

Contribution guidelines

Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/asynkio.

Dependencies

asynkio has no runtime dependencies beyond the Python standard library (asyncio).

Efferent (fan-out)

Libraries upon which asynkio depends:

None.

Development Dependencies

• aiofiles — development and demonstration tooling;
• black — code formatter;
• diagnosticism — example scripts under examples/;
• pyclasp — development and demonstration tooling;
• pytest — unit-test runner;

Afferent (fan-in)

Projects that depend on asynkio:

None (currently).

Related projects

• Tokio (Rust) — the library whose time types asynkio emulates;
• Diagnosticism.Python — used in examples/ scripts;

License

asynkio is released under the 3-clause BSD license. See LICENSE for details.