Support Guidelines

Support Guidelines#

Thank you for using asyncutils! This document outlines how to get help with this project.

Before jumping to seek support, do skim through the readme.

Bug Reports#

If you’ve found a bug, please check if it’s already reported in Issues. If so, participate meaningfully there; otherwise, use make bug to file a bug report. Please await review and try your best to respond to questions.

Feature Requests#

Have an idea? We’d love to hear it!

  • Search existing issues to avoid duplicates

  • Explain the use case and expected behaviour

  • Include examples in non-trivial cases

Questions#

Read the FAQ below. If your question is not resolved, ask in GitHub Discussions

Security Issues#

Never report security vulnerabilities publicly.

See the security policy for details.

Common Issues & Solutions#

Installation Problems#

Update your package installer, then try the following fixes:

uv pip install -U py-asyncutils # Upgrade
uv pip check # Check for dependency shenanigans
uv pip uninstall py-asyncutils && uv pip install py-asyncutils # Clean install

Other (slower) package managers:

pip install -U pipx && pipx ensurepath # pipx, installed with pip
conda update py-asyncutils # conda
# pip
pip install -U pipdeptree
pipdeptree # More clutter than uv pip tree, showing a single package repeatedly
pipdeptree --packages py-asyncutils # Only this package, like uv tree

Import Errors#

Check if asyncutils is installed:

# uv
uv pip show py-asyncutils
# pip
pip show py-asyncutils
# or
pip list | grep py-asyncutils

If the package is not working with python, perform the steps below:

# Check sys.path
python3 -c "print(*__import__('sys').path, sep='\n')"
# Check for package naming conflicts; following snippet should print altlocks, base,
# buckets, channels, cli, compete, config, ... separated by newlines
python3 -c "print(*__import__('asyncutils').__all__, sep='\n')"

Response Times#

As fast as I can; that is:

  • Bug reports: 3 days

  • Feature requests: Reviewed biweekly

  • Security issues: 1 day

  • General questions: Community-driven

Remarks#

Don’t:

  • Bump issues with +1 or “me too”

  • Email maintainers unless urgent

  • Ask about ETA of features/fixes

  • Post API keys or passwords

Instead:

  • React to issues

  • Open discussions or issues, or a pull request if the problem is easily fixable

  • Be patient

Once again, thank you for supporting this small project. Happy programming!