Baguette
========

.. image:: /_static/images/banner.png

Baguette is an asynchronous web framework for ASGI servers.

.. image:: https://img.shields.io/pypi/v/baguette?color=blue
    :target: https://pypi.python.org/pypi/baguette
    :alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/baguette?color=orange
    :target: https://pypi.python.org/pypi/baguette
    :alt: PyPI supported Python versions
.. image:: https://img.shields.io/pypi/dm/baguette
    :target: https://pypi.python.org/pypi/baguette
    :alt: PyPI downloads
.. image:: https://readthedocs.org/projects/baguette/badge/?version=latest
    :target: https://baguette.readthedocs.io/en/latest/
    :alt: Documentation Status
.. image:: https://img.shields.io/github/license/takos22/baguette?color=brightgreen
    :target: https://github.com/takos22/baguette/blob/master/LICENSE
    :alt: License: MIT
.. image:: https://img.shields.io/discord/831992562986123376.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2
    :target: https://discord.gg/PGC3eAznJ6
    :alt: Discord support server

**Features:**

- Easy to develop
- High performance framework, especially when using the uvicorn server

Getting started
---------------

Is this your first time using the framweork? This is the place to get started!

- **First steps:** :ref:`intro` | :ref:`quickstart`
- **Examples:** Many examples are available in the
  :resource:`repository <examples>`.

Getting help
------------

If you're having trouble with something, these resources might help.

- Ask us and hang out with us in our :resource:`Discord <discord>` server.
- If you're looking for something specific, try the :ref:`index <genindex>`
  or :ref:`searching <search>`.
- Report bugs in the :resource:`issue tracker <issues>`.


User Guide
----------

.. toctree::
    :maxdepth: 1

    user_guide/intro
    user_guide/quickstart
    user_guide/view
    user_guide/routing
    user_guide/request
    user_guide/responses
    user_guide/middlewares
    user_guide/testing


API Reference
-------------

.. toctree::
    :maxdepth: 3

    api


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

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

.. toctree::
    :caption: References
    :hidden:

    GitHub Repository <https://github.com/takos22/baguette>
    Examples <https://github.com/takos22/baguette/tree/master/examples>
    Issue Tracker <https://github.com/takos22/baguette/issues>
    Discord support server <https://discord.gg/PGC3eAznJ6>