Installation

Added in version 0.8.20.

Changed in version 0.9.10: Use uv as the build backend in pyproject.toml.

No setup is required, besides ensuring that your package manager is updated to the latest version as follows:

# pip:
pip install -U pip
# pipx:
pip install -U pipx
# conda:
conda update conda anaconda
conda update --all # optional
# uv (preferred for modernity, speed and compatibility with this project):
uv self update # may not work if uv was installed with pip
pip install -U uv # in that case
# poetry:
poetry self update
# pdm:
pip install -U pdm
# pipenv:
pip install -U pipenv

Added in version 0.8.13: Achieved distribution on conda-forge and by extension, conda installation support.

Next, install py-asyncutils:

# recommended: pip
pip install py-asyncutils==|version|  # directly from source
pip install git+https://github.com/jonathandung/asyncutils.git
# for development, after:
git clone https://github.com/jonathandung/asyncutils.git
cd asyncutils
# you have the three options below:
pip install -e .
make install
make install-silent # no clutter
# the last two options need GNU Make on *nix, but the Windows version points to a batch file.
# uv is invoked under the hood and installed if absent; pip is not needed!

other installation pathways:

pipx install py-asyncutils==|version| # pipx
conda install -c conda-forge py-asyncutils=|version| # conda
# alternatively:
conda config --add channels conda-forge
conda config --set channel_priority strict
conda install py-asyncutils==|version|
# uv essentially supports the same interface as pip with uv pip
poetry add py-asyncutils@|version| # poetry
pdm add py-asyncutils==|version| # pdm
pipenv install py-asyncutils==|version| # pipenv
# no package manager (needs the build and installer packges)
python -m build # generate sdist and wheel in dist/
python -m installer dist/*.whl # install from the wheel

Note

We will never add setup.py, since only pyproject.toml is the modern way to go.

After this, as long as you have the python Scripts (Windows) or bin (otherwise) directory on PATH, asyncutils and autils will be made available as entry points to the asyncutils CLI, which can also be called with a typical and perhaps more familiar python -m asyncutils.

Refer to Support Guidelines for steps to check the installation.

Extras

The all extra includes the dependencies for development, which are not required for normal usage. To install with extras, use the syntax appropriate for your package manager as shown in the installation instructions above.

The extras are listed below for reference:

  • all: All the extras combined

  • dev: Packages one would want installed for development; superset of docs, themes, json5, test, tools, and includes pre-commit as well. Notably, ruff and ty are absent because it is recommended to install them with uv, which renders them unspecifiable as dependencies.

  • docs: Documentation dependencies, including Sphinx and some of its plugins, along with sphinx-lint

  • executors: All the libraries implementing executors this module supports, except distributed, since that is much too specialized and heavy.

  • json5: The JSON5 parser, specifically used to read format.json5 in tests.

  • pconf: Dependencies to parse configuration files in Hjson, JSONC, JSON5, and YAML formats

  • ptw: Monitor test failures on the command line while editing code through pytest-watch

  • test: Test dependencies, including pytest and related plugins

  • themes: Sphinx themes, including furo and sphinx-book-theme, used in the Read the Docs and GitHub Pages builds respectively; superset of docs.

Changed in version 0.9.9: Added pytest-asyncio-cooperative to the test extra.

Added in version 0.9.7: The themes extra, to make CI/CD steps involving documentation deployment more convenient.

Removed in version 0.9.5: The pub extra, because uv already provides that functionality.

Removed in version 0.9.5: mypy is no longer in any extra, since ty provides type checking.

Changed in version 0.9.3: Removed the pytest-local-badge dependency from pytest’s required plugins. However, it is still present in the tests group for convenience of development.

Removed in version 0.9.2: The tools extra. Install uv yourself if you wish.

Added in version 0.9.2: The executors extra.

Added in version 0.9.1: The ptw extra.

Removed in version 0.9.1: The dlint extra, since doc8 no longer appears to be maintained.

Changed in version 0.9.0: Completely reorganized optional dependencies, moving them around among groups.