Skip to main content

A django application to display cute animal pictures based on HTTP status codes.

Project description

Test Coverage Latest PyPI version python django licence

Return a more fun and cute animal picture to your users based upon the HTTP response codes.

Demo Responses

Some of these responses may look like:

  • 404(Resource not found)

Resource not found.
  • 400(Bad request)

Bad request.

Installation

Install using pip.

$ python -m pip install django-cute-status

If you want, you may install it from the source, grab the source code and run setup.py.

$ git clone git://github.com/abhiabhi94/django-cute-status.git
$ cd django-cute-status
$ python setup.py install

Usage

Add app

To enable django_flag_app in your project you need to add it to INSTALLED_APPS in your projects settings.py file:

INSTALLED_APPS = (
    ...
    'django_cute_status',
    ...
)

Add middleware

Add the following middleware class to monitor the responses. Make sure it is at the bottom.

MIDDLEWARES = [
    ...
    'django_cute_status.middleware.CuteStatusMiddleware',
]

Configurations

There are certain configurations that allow you to customize the application.

CUTE_STATUS_BASE_URLS

This is the list of URLs to be used for displaying cute statuses. At the moment, the app only displays the pictures of dogs and cats. In case you know of any more such services(for e.g. one for pandas) you may add them here. Also, it would be great if you could take a moment to make a pull request to add the feature here as well. Defaults to :

 = (
    'https://http.dog/{status_code}.jpg',
    'https://http.cat/{status_code}.jpg',
)

CUTE_STATUS_BASE_URL

The default URL for displaying cute statuses. Suppose, you want only cat pictures as status code, you can use this by setting it to http://http.cat/{status_code}. This is useful only when you have set CUTE_STATUS_USE_RANDOM to False.

CUTE_STATUS_BASE_TEMPLATE

The base template used for rendering cute statuses. It is advisable to override this to cater the web page according to your needs. For example, you might want your header and footer etc. to also be added along the cute status codes. Defaults to 'django_cute_status/base.html'.

CUTE_STATUS_USE_RANDOM

This tells whether to display cute statuses using one of the available URLs randomly. Defaults to True.

CUTE_STATUS_FOR_CODES

This a list of status code for which cute status will be displayed. Defaults to cute_status_for_codes.

CUTE_STATUS_NOT_FOR_CODES

This is a list of status code for which cute status will not be displayed. You may want to display text as per you business logic. Defaults to cute_status_not_for_codes.

CUTE_STATUS_HEADER

This is the header sent added to the response. It can be useful in determining when you want to render your own responses, CSS, JS, media files etc. Defaults to 'X-Cute-Status'.

CUTE_STATUS_OVERRIDE_HEADER_ON_ALL

Whether to add the CUTE_STATUS_HEADER on all HTTP requests or not. Defaults to False.

Credits

The application wouldn’t have been possible without the excellent pictures served by https://http.dog and https://http.cat. Many thanks to them for their cute pictures.

Development

For setting up development environment, you may see the guidelines at CONTRIBUTING.rst.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-cute-status-1.1.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

django_cute_status-1.1.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file django-cute-status-1.1.0.tar.gz.

File metadata

  • Download URL: django-cute-status-1.1.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for django-cute-status-1.1.0.tar.gz
Algorithm Hash digest
SHA256 e834eb82b4ac8b9b29288d13f77c55d917792884afc10fde60a6d40ccb8376e2
MD5 b51cf9c2de6879280a4658d9c0037b4b
BLAKE2b-256 bc86be39c3faccdc0a526bdfb79f302dd629f933df2eba5894019b9895e3d8b5

See more details on using hashes here.

File details

Details for the file django_cute_status-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_cute_status-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 99d09aec29e59ad85975eb6390e411826209a41d3f781abd064da86006c59461
MD5 789f583916c15b63d4bc30ef9042dd95
BLAKE2b-256 c1d12b7bc2052bbb2bcb580d4e72beb7ac91ffadfa231eefe21524a7ef238f30

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page