GitXplorerGitXplorer
b

django-htcpcp-tea

public
5 stars
0 forks
3 issues

Commits

List of commits on branch master.
Verified
7fc26b0cbf4f818734b12f7d68d9f712a82d186b

Remove old setup.py build system files

bbrianschubert committed 2 years ago
Verified
3c99fa7e1f340a7aabfc26ca4ffe8cb8a0cd7dad

Merge branch 'feat/modernize-build-system' into development

bbrianschubert committed 2 years ago
Verified
eabab26cbde1ffc5000c23e1d6d00630b7b2c3d5

Update temporary dev db

bbrianschubert committed 2 years ago
Verified
b7f47dea3dab15bbe6c9106ed84016211367fbfb

Include docs with sdist builds

bbrianschubert committed 2 years ago
Verified
540ea8896bd7e7c90aff64667f4e24607de76217

Add old documentation warning to examples page

bbrianschubert committed 2 years ago
Verified
ae736d230c9d3d3b3b13142271eeb96317dc678c

Update CHANGELOG.rst

bbrianschubert committed 2 years ago

README

The README file for this repository.

Django HTCPCP-TEA

.. image:: https://travis-ci.com/blueschu/django-htcpcp-tea.svg?branch=master :target: https://travis-ci.com/blueschu/django-htcpcp-tea :alt: Travis CI Build

.. image:: https://coveralls.io/repos/github/blueschu/django-htcpcp-tea/badge.svg?branch=master :target: https://coveralls.io/github/blueschu/django-htcpcp-tea?branch=master :alt: Coverage

.. image:: https://readthedocs.org/projects/django-htcpcp-tea/badge/?version=latest :target: https://django-htcpcp-tea.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/django-htcpcp-tea.svg :target: https://pypi.org/project/django-htcpcp-tea/ :alt: PyPI - django-htcpcp-tea

.. image:: https://img.shields.io/github/license/blueschu/django-htcpcp-tea.svg :target: ./LICENSE :alt: License

..

[T]here is a strong, dark, rich requirement for a protocol designed
espressoly for the brewing of coffee.

--- RFC 2324 Section 1

A Django_ app that implements the TEA extension to HTCPCP as defined in RFC 7168_.

This app extends the Django web framework to simulate the functionality of an HTCPCP server. Both the HTCPCP/1.0 protocol from RFC 2324_ and the HTCPCP-TEA protocol from RFC 7168_ are supported.

.. _RFC 7168: https://tools.ietf.org/html/rfc7168 .. _Django: https://www.djangoproject.com/ .. _RFC 2324: https://tools.ietf.org/html/rfc2324

Notable features:

  • Customizable coffee and teapots
  • Support for BREW and WHEN HTTP methods
  • Interactive brewing sessions
  • HTCPCP response codes (e.g. 418 I'm a teapot)
  • User-defined forbidden combinations of beverage additions

Documentation

Documentation for Django HTCPCP-TEA is available on Read the Docs_.

.. _Read the Docs: https://django-htcpcp-tea.readthedocs.io/en/latest/?badge=latest

References

  • [RFC 2324] Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0)_
  • [RFC 7158] The Hyper Text Coffee Pot Control Protocol for Tea Efflux Appliances (HTCPCP-TEA)_
  • [RFC 2295] Transparent Content Negotiation in HTTP_
  • MDN Web Docs | HTTP response codes_

.. _[RFC 2324] Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0): https://tools.ietf.org/html/rfc2324 .. _[RFC 7158] The Hyper Text Coffee Pot Control Protocol for Tea Efflux Appliances (HTCPCP-TEA): https://tools.ietf.org/html/rfc7168 .. _[RFC 2295] Transparent Content Negotiation in HTTP: https://tools.ietf.org/html/rfc2295 .. _MDN Web Docs | HTTP response codes: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

Related Work

  • Shane Brunswick's Save 418 Movement_.
  • Dash Winterson's HTCPCP Middleware (django-htcpcp)_

.. _Save 418 Movement: http://save418.com/ .. _HTCPCP Middleware (django-htcpcp): https://github.com/dashdanw/django-htcpcp

License

This software is licensed under the MIT License. For more information, read the file LICENSE.

.. _MIT License: https://opensource.org/licenses/MIT .. _LICENSE: ./LICENSE