File: index.rst

package info (click to toggle)
python-aiosasl 0.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 292 kB
  • sloc: python: 1,999; makefile: 151
file content (30 lines) | stat: -rw-r--r-- 874 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
.. aiosasl documentation master file, created by
   sphinx-quickstart on Wed Dec  9 12:45:22 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to aiosasl's documentation!
===================================

:mod:`aiosasl` is a generic SASL implementation for use with :mod:`asyncio`
protocols. It makes very few assumptions about the protocol which uses SASL,
making it usable in different contexts. The assumptions are:

* It uses SASL, i.e. you can perform SASL initiation, responses and abortions.

* Those actions can be encapsulated in :mod:`asyncio` coroutines which return
  the server response.

API Reference
=============

.. automodule:: aiosasl

.. automodule:: aiosasl.channel_binding

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`