Skip to content

SUPPORT.md

Latest commit

 

History

History
126 lines (84 loc) · 3.4 KB

SUPPORT.md

File metadata and controls

126 lines (84 loc) · 3.4 KB

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:

  1. Check if it's already reported in Issues
  2. Create a new issue if not
  3. Refer and adhere to the issue template chosen, or risk your issue being closed without going through actual review

Feature Requests

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

  • Search existing issues to avoid duplicates
  • Explain the use case and expected behavior
  • Include examples unless you think the idea is a no-brainer

Questions

Community Support

Quick Questions

For quick questions, consider:

  • Checking existing issues/discussions
  • Reading the FAQ section below
  • Asking in community channels

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:

# Upgrade
pip install -U py-asyncutils

# Check for dependency shenanigans
pip check # Exit code should be zero

# If you are limited to pip:
pip install -U pipdeptree
pipdeptree # Pretty print the pip packages dependency tree
pipdeptree --packages py-asyncutils # Show only the dependents and dependencies of this package

# For uv (much faster):
uv pip install -U py-asyncutils
uv pip check
uv pip tree # Also has less clutter, avoiding showing a single package repeatedly
uv pip tree --package py-asyncutils # Only this package as above

# Clean install
pip uninstall py-asyncutils
pip install py-asyncutils

# If using pipx, likely installed with pip
pip install -U pipx
pipx ensurepath

# If using conda
conda update py-asyncutils

Import Errors

Check if asyncutils is installed:

pip list | grep py-asyncutils # optionally prefix with uv if using it

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, console
# constants, context, events, exceptions, ... separated by newlines
python3 -c "print(*__import__('asyncutils').__all__, sep='\n')"
# If not loading site, repeat the above steps w/ python3 -Sc

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

I will try to make a post on the discussions page (e.g. hiatus announcement) and set my status to 'On vacation' or similar in case of inactivity such that I cannot fulfill these promises or meet other deadlines I set myself.

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!