.. image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct.svg
:target: https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md
:alt: SWUbanner

.. image:: https://img.shields.io/pypi/v/cheroot.svg
:target: https://pypi.org/project/cheroot

.. image:: https://tidelift.com/badges/package/pypi/cheroot
:target: https://tidelift.com/subscription/pkg/pypi-cheroot?utm_source=pypi-cheroot&utm_medium=readme
:alt: Cheroot is available as part of the Tidelift Subscription

.. image:: https://github.com/cherrypy/cheroot/actions/workflows/ci-cd.yml/badge.svg
:target: https://github.com/cherrypy/cheroot/actions/workflows/ci-cd.yml
:alt: GitHub Actions CI/CD Workflow

.. image:: https://img.shields.io/badge/license-BSD-blue.svg?maxAge=3600
:target: https://pypi.org/project/cheroot

.. image:: https://img.shields.io/pypi/pyversions/cheroot.svg
:target: https://pypi.org/project/cheroot

.. image:: https://codecov.io/gh/cherrypy/cheroot/branch/main/graph/badge.svg
:target: https://codecov.io/gh/cherrypy/cheroot
:alt: codecov

.. image:: https://readthedocs.org/projects/cheroot/badge/?version=latest
:target: https://cheroot.cherrypy.dev/en/latest/?badge=latest

.. image:: https://img.shields.io/badge/StackOverflow-Cheroot-blue.svg
:target: https://stackoverflow.com/questions/tagged/cheroot+or+cherrypy

.. image:: https://img.shields.io/matrix/octomachinery:matrix.org?label=Discuss%20on%20Matrix%20at%20%23cherrypy%3Amatrix.org&logo=matrix&server_fqdn=matrix.org&style=flat
:target: https://matrix.to/#/%23cherrypy:matrix.org
:alt: Matrix Room — #cherrypy:matrix.org

.. image:: https://img.shields.io/matrix/pyba:matrix.org?label=Discuss%20on%20Matrix%20at%20%23cherrypy-space%3Amatrix.org&logo=matrix&server_fqdn=matrix.org&style=flat
:target: https://matrix.to/#/%23cherrypy-space:matrix.org
:alt: Matrix Space — #cherrypy-space:matrix.org

.. image:: https://img.shields.io/gitter/room/cherrypy/cherrypy.svg
:target: https://gitter.im/cherrypy/cherrypy

.. image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
:target: https://web.archive.org/web/20250306034535/https://makeapullrequest.com/

.. image:: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcherrypy%2Fcheroot.svg?type=shield
:target: https://app.fossa.io/projects/git%2Bgithub.com%2Fcherrypy%2Fcheroot?ref=badge_shield
:alt: FOSSA Status

Cheroot is the high-performance, pure-Python HTTP server used by CherryPy.

Status

The test suite currently relies on pytest. It's being run via GitHub
Actions CI/CD workflows.

For Enterprise

Professional support for Cheroot is available as part of the
Tidelift Subscription_. The CherryPy maintainers and the
maintainers of thousands of other packages are working with
Tidelift to deliver one enterprise subscription that covers all
of the open source you use.

Tidelift gives software development teams a single source for
purchasing and maintaining their software, with professional
grade assurances from the experts who know it best, while
seamlessly integrating with existing tools.

Learn more <Tidelift Subscription_>_.

.. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-cheroot?utm_source=pypi-cheroot&utm_medium=referral&utm_campaign=readme

Contribute Cheroot

Want to add something to upstream? Feel free to submit a PR or file an issue
if unsure. Please follow CherryPy's common contribution guidelines <https://github.com/cherrypy/cherrypy/blob/main/.github/CONTRIBUTING.rst>_.
Note that PR is more likely to be accepted if it includes tests and detailed
description helping maintainers to understand it better 🎉

Oh, and be pythonic, please 🐍

Don't know how? Check out How to Contribute to Open Source <https://opensource.guide/how-to-contribute/>_ article by GitHub 🚀

License

.. image:: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcherrypy%2Fcheroot.svg?type=large
:target: https://app.fossa.io/projects/git%2Bgithub.com%2Fcherrypy%2Fcheroot?ref=badge_large
:alt: FOSSA Status