Welcome to bushel's documentation!
==================================

*A bushel of onions is 57lbs.*

.. image:: _static/localonions.png

bushel contains a number of tools for interacting with Tor networks and
Tor-related data. Many design decisions have been taken to specifically benefit
the use-cases of `Tor Metrics <https://metrics.torproject.org/>`_. If you are
looking for a general-purpose library for working with Tor, you may instead
want to look at `stem <https://stem.torproject.org/>`_.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   archive
   bandwidth
   collector
   directory
   downloader
   monitoring
   plugins
   references

The requirements and initial design specification for the Tor directory archive
can be found in the 2019 Technical Report [modern-collector]_.

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

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