Getting started

Requirements

aiostem requires Python ≥ 3.10.

Use the most recent Python release

For each minor version (3.x), only the latest bugfix or security release (3.x.y) is officially supported.

Runtime dependencies are documented on a separate pages.

Installation

This installs a package that then be imported from Python (import aiostem).

From PyPi

aiostem can be installed from PyPi:

python -m pip install aiostem

The wheel package is generic and should work on most platforms.

From source

The following command pulls the github repository, builds and installs locally:

python -m pip install git+https://github.com/morian/aiostem/

Tutorial

• 01. Connection
  • TCP port connection
  • Socket file connection
  • Advanced connection
• 02. Authentication
  • Authentication methods
  • Password authentication
  • Cookie file authentication
• 03. Commands
  • Read configuration options
  • Read server information
  • Create an onion service
• 04. Events
  • List of events
  • Subscribe to events
• 05. Monitor