A reusable Django app to work with opening hours.
Project description
A reusable Django app to work with opening hours.
Comes with the following features:
Multiple company (premises) support, customisable to directly plug in your own model.
Able to show if a company is currently open (“Come in, we’re open!”, “Sorry, we’re closed.”).
Able to list the opening hours, e.g. Monday 9am to 5pm, etc. for multiple company premises.
Possible to define opening hours passing midnight.
Possible to define closing hours, e.g. for holiday.
Installation
To get the latest stable release from PyPi
pip install django-openinghours
To get the latest version from GitHub
pip install -e git+git://github.com/arteria/django-openinghours.git#egg=openinghours-master
Add openinghours to your INSTALLED_APPS
INSTALLED_APPS = (
...,
'openinghours',
)
You can use the company model provided or plug your own using settings.py:
OPENINGHOURS_PREMISES_MODEL = 'yourcastleapp.Castle'
Add the openinghours URLs to your urls.py
urlpatterns = [
...
url(r'^openinghours/', include('openinghours.urls')),
]
Before your tags/filters are available in your templates, load them using
{% load openinghours_tags %}
Create your tables
./manage.py migrate openinghours
Set 'TIME_ZONE' in your project settings.
Usage
Set up a company
This app supports multiple companies (or your custom model) with multiple opening and closing hours.
Set up opening hours
Used to describe when premises are open, defined on a daily basis (per day) by defining one or more start and end times of opening slots.
Optionally, set up the closing hour rules
This is used to define when premises are closed (e.g. due to a holiday, absences, sickness or similar). Please note that the closing hours override the opening hours.
You can find examples of how to use this app in our templates.
Remarks
Opening hours is built using datetime’s isoweekday. This means Monday is represented by number 1 and Sunday by 7.
Planned features
Priority 1 = high/must have, 2 = and 3 = low/nice to have
1 Migrate to Django’s timezone
2 Docs for live testing of defined rules
3 Shortcut for everyday (1-7) = 0 in WEEKDAYS, or 8 = monday to friday, etc.
3 Global closing hours to override all companies. Use cases: close a whole shopping centre
Contribute
Just send us your pull request. File and issue. Use it. Talk about it. Thank you
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for django-openinghours-0.1.3.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5c6752c96d1d56f88e55383f1b298fab6a7a7a4f034e058ae858d7d337efcd60 |
|
| MD5 | 33698d62380fecb206ad97a9052b7a23 |
|
| BLAKE2b-256 | 0bc362a985d4ea8c9e16bee3806907ea593f46444f79dbf6a003418c0fc0edc7 |
