https://github.com/twisted/klein

werkzeug + twisted.web
https://github.com/twisted/klein

async async-python klein micro-framework python twisted web-framework

Last synced: 14 days ago
JSON representation

werkzeug + twisted.web

• Host: GitHub
• URL: https://github.com/twisted/klein
• Owner: twisted
• License: other
• Created: 2012-02-10T17:55:04.000Z (over 12 years ago)
• Default Branch: trunk
• Last Pushed: 2024-10-07T23:17:10.000Z (27 days ago)
• Last Synced: 2024-10-09T17:23:50.478Z (25 days ago)
• Topics: async, async-python, klein, micro-framework, python, twisted, web-framework
• Language: Python
• Homepage:
• Size: 2.37 MB
• Stars: 833
• Watchers: 40
• Forks: 121
• Open Issues: 100
• Metadata Files:
  • Readme: README.rst
  • Changelog: NEWS.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Authors: AUTHORS

Awesome Lists containing this project

• starred-awesome - klein - werkzeug + twisted.web (Python)
• best-of-web-python - GitHub - 49% open · ⏱️ 15.04.2024): (Others)

README

        
============================

Klein, a Web Micro-Framework

============================

.. image:: https://github.com/twisted/klein/workflows/CI/badge.svg?branch=trunk

    :target: https://github.com/twisted/klein/actions

    :alt: Build Status

.. image:: https://codecov.io/github/twisted/klein/coverage.svg?branch=trunk

    :target: https://codecov.io/github/twisted/klein?branch=trunk

    :alt: Code Coverage

.. image:: https://img.shields.io/pypi/pyversions/klein.svg

    :target: https://pypi.org/project/klein

    :alt: Python Version Compatibility

Klein is a micro-framework for developing production-ready web services with Python.

It is 'micro' in that it has an incredibly small API similar to `Bottle `_ and `Flask `_.

It is not 'micro' in that it depends on things outside the standard library.

This is primarily because it is built on widely used and well tested components like `Werkzeug `_ and `Twisted `_.

A `Klein bottle `_ is an example of a non-orientable surface, and a glass Klein bottle looks like a twisted bottle or twisted flask.

This, of course, made it too good of a pun to pass up.

Klein's documentation can be found at `Read The Docs `_.

Example

========

This is a sample Klein application that returns 'Hello, world!', running on port ``8080``.

.. code-block:: python

    from klein import run, route

    @route('/')

    def home(request):

        return 'Hello, world!'

    run("localhost", 8080)

Contribute

==========

``klein`` is hosted on `GitHub `_ and is an open source project that welcomes contributions of all kinds from the community, including:

- code patches,

- `documentation `_ improvements,

- `bug reports `_,

- reviews for `contributed patches `_.

For more information about contributing, see `the contributor guidelines `_.