statusboard
===========
`|Build Status| <https://travis-ci.org/edigiacomo/django-statusboard>`_
`|Pypi| <https://pypi.python.org/pypi/django-statusboard/>`_
Status page application.
Installation
------------
Install the package
::
pip install django-statusboard
Add the following applications to your Django projects
::
INSTALLED_APPS += [
'django.contrib.humanize',
'rest_framework',
'statusboard',
]
Update your urlconf:
::
# myproject/urls.py
urlpatterns += [
url(r'^statusboard/$', include('statusboard.urls')),
]
Update your database
::
./manage migrate
Configuration
-------------
You can configure the app using the dict ``STATUSBOARD`` in
``settings.py``:
::
STATUSBOARD = {
INCIDENT_DAYS_IN_INDEX: 7,
OPEN_INCIDENT_IN_INDEX: True,
}
- ``INCIDENT_DAYS_IN_INDEX``: number of days to show in index (1 =
today).
- ``OPEN_INCIDENT_IN_INDEX``: show not fixed incidents in index.
Customize pages
---------------
The following blocks are customizable in ``statusboard/base.html``:
- ``title``: title of the page
- ``branding``: branding in fixed navbar
- ``bootstrap_theme``: bootstrap theme
- ``header``: header of the page
- ``userlinks``: links in the header
- ``footer``: footer div
- ``style``: ``CSS`` files
- ``script``: JavaScript files
Example: change branding and title
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Django 1.8
^^^^^^^^^^
Copy ``statusboard/templates/statusboard/base.html`` in one of your
templates dir and edit the file.
Django >= 1.9
^^^^^^^^^^^^^
In Django >= 1.9, the templates can be extended recursively (see
https://docs.djangoproject.com/en/1.10/releases/1.9/).
Create a ``statusboard/base.html`` in one of your templates dir:
::
{% extends `statusboard/base.html %}
{% block title %}
ACME, Inc.
{% endblock %}
{% block branding %}
<a class="navbar-brand" href="{% url 'statusboard:index' %}">ACME status</a>
{% endblock %}
.. |Build
Status| image:: https://travis-ci.org/edigiacomo/django-statusboard.svg?branch=master
.. |Pypi| image:: https://img.shields.io/pypi/v/django-statusboard.svg
===========
`|Build Status| <https://travis-ci.org/edigiacomo/django-statusboard>`_
`|Pypi| <https://pypi.python.org/pypi/django-statusboard/>`_
Status page application.
Installation
------------
Install the package
::
pip install django-statusboard
Add the following applications to your Django projects
::
INSTALLED_APPS += [
'django.contrib.humanize',
'rest_framework',
'statusboard',
]
Update your urlconf:
::
# myproject/urls.py
urlpatterns += [
url(r'^statusboard/$', include('statusboard.urls')),
]
Update your database
::
./manage migrate
Configuration
-------------
You can configure the app using the dict ``STATUSBOARD`` in
``settings.py``:
::
STATUSBOARD = {
INCIDENT_DAYS_IN_INDEX: 7,
OPEN_INCIDENT_IN_INDEX: True,
}
- ``INCIDENT_DAYS_IN_INDEX``: number of days to show in index (1 =
today).
- ``OPEN_INCIDENT_IN_INDEX``: show not fixed incidents in index.
Customize pages
---------------
The following blocks are customizable in ``statusboard/base.html``:
- ``title``: title of the page
- ``branding``: branding in fixed navbar
- ``bootstrap_theme``: bootstrap theme
- ``header``: header of the page
- ``userlinks``: links in the header
- ``footer``: footer div
- ``style``: ``CSS`` files
- ``script``: JavaScript files
Example: change branding and title
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Django 1.8
^^^^^^^^^^
Copy ``statusboard/templates/statusboard/base.html`` in one of your
templates dir and edit the file.
Django >= 1.9
^^^^^^^^^^^^^
In Django >= 1.9, the templates can be extended recursively (see
https://docs.djangoproject.com/en/1.10/releases/1.9/).
Create a ``statusboard/base.html`` in one of your templates dir:
::
{% extends `statusboard/base.html %}
{% block title %}
ACME, Inc.
{% endblock %}
{% block branding %}
<a class="navbar-brand" href="{% url 'statusboard:index' %}">ACME status</a>
{% endblock %}
.. |Build
Status| image:: https://travis-ci.org/edigiacomo/django-statusboard.svg?branch=master
.. |Pypi| image:: https://img.shields.io/pypi/v/django-statusboard.svg
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-statusboard-0.3.31.tar.gz
(207.8 kB
view details)
File details
Details for the file django-statusboard-0.3.31.tar.gz.
File metadata
- Download URL: django-statusboard-0.3.31.tar.gz
- Upload date:
- Size: 207.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
02f97ef857bb930d41ffdd3e161afd112516895c583c2c56af6324fb780b5580
|
|
| MD5 |
43a057fe717d200b64047e01ee1003d7
|
|
| BLAKE2b-256 |
77133485081a0cff062d3076e44caf07963ff8c616c042850a960464145d57de
|
