πŸ›  InstallationΒΆ

  • Install a Python version >=3.10,<3.15.

  • From PyPI πŸƒβ€β™€οΈ:

    pip install afk-bot
    # or
    uv add afk-bot
    
  • Development uses uv. Install uv from the installation docs, then sync πŸƒβ€β™€οΈ:

    uv sync
    
  • Documentation build extras (Sphinx / Furo / MyST):

    uv sync --group docs
    
  • CLI entry point:

    afk-bot --help
    # or
    uv run afk-bot --help
    
  • Task runner is Poe the Poet:

    uv tool install poethepoet
    poe greet
    poe sphinx
    
  • Prefer an isolated environment (uv, venv, or conda) so project deps do not collide with other packages.