Define clinic facilities for clinicedc/edc projects
Project description
|pypi| |travis| |codecov| |downloads|
edc-facility
------------
Customizing appointment scheduling by ``Facility``
++++++++++++++++++++++++++++++++++++++++++++++++
Appointment scheduling can be customized per ``facility`` or clinic:
Add each facility to ``app_config.facilities`` specifying the facility ``name``, ``days`` open and the maximum number of ``slots`` available per day:
.. code-block:: python
from edc_facility.apps import AppConfig as EdcAppointmentAppConfig
class AppConfig(EdcAppointmentAppConfig):
facilities = {
'clinic1': Facility(name='clinic', days=[MO, TU, WE, TH, FR], slots=[100, 100, 100, 100, 100])}
'clinic2': Facility(name='clinic', days=[MO, WE, FR], slots=[30, 30, 30])}
To schedule an appointment that falls on a day that the clinic is open, isn't a holiday and isn't already over-booked:
.. code-block:: python
from edc_base.utils import get_utcnow
from .facility import Facility
suggested_datetime = get_utcnow()
available_datetime = facility.available_datetime(suggested_datetime)
If holidays are entered (in model ``Holiday``) and the appointment lands on a holiday, the appointment date is incremented forward to an allowed weekday. Assuming ``facility`` is configured in ``app_config`` to only schedule appointments on [TU, TH]:
.. code-block:: python
from datetime import datetime
from dateutil.relativedelta import TU, TH
from django.conf import settings
from django.utils import timezone
from .facility import Facility
from .models import Holiday
Holiday.objects.create(
name='Id-ul-Adha (Feast of the Sacrifice)',
date=date(2015, 9, 24)
)
suggested_datetime = timezone.make_aware(datetime(2015, 9, 24), timezone=pytz.utc) # TH
available_datetime = facility.available_datetime(suggested_datetime)
print(available_datetime) # 2015-09-29 00:00:00, TU
The maximum number of possible scheduling slots per day is configured in ``app_config``. As with the holiday example above, the appointment date will be incremented forward to a day with an available slot.
.. |pypi| image:: https://img.shields.io/pypi/v/edc-facility.svg
:target: https://pypi.python.org/pypi/edc-facility
.. |travis| image:: https://travis-ci.org/clinicedc/edc-facility.svg?branch=develop
:target: https://travis-ci.org/clinicedc/edc-facility
.. |codecov| image:: https://codecov.io/gh/clinicedc/edc-facility/branch/develop/graph/badge.svg
:target: https://codecov.io/gh/clinicedc/edc-facility
.. |downloads| image:: https://pepy.tech/badge/edc-facility
:target: https://pepy.tech/project/edc-facility
edc-facility
------------
Customizing appointment scheduling by ``Facility``
++++++++++++++++++++++++++++++++++++++++++++++++
Appointment scheduling can be customized per ``facility`` or clinic:
Add each facility to ``app_config.facilities`` specifying the facility ``name``, ``days`` open and the maximum number of ``slots`` available per day:
.. code-block:: python
from edc_facility.apps import AppConfig as EdcAppointmentAppConfig
class AppConfig(EdcAppointmentAppConfig):
facilities = {
'clinic1': Facility(name='clinic', days=[MO, TU, WE, TH, FR], slots=[100, 100, 100, 100, 100])}
'clinic2': Facility(name='clinic', days=[MO, WE, FR], slots=[30, 30, 30])}
To schedule an appointment that falls on a day that the clinic is open, isn't a holiday and isn't already over-booked:
.. code-block:: python
from edc_base.utils import get_utcnow
from .facility import Facility
suggested_datetime = get_utcnow()
available_datetime = facility.available_datetime(suggested_datetime)
If holidays are entered (in model ``Holiday``) and the appointment lands on a holiday, the appointment date is incremented forward to an allowed weekday. Assuming ``facility`` is configured in ``app_config`` to only schedule appointments on [TU, TH]:
.. code-block:: python
from datetime import datetime
from dateutil.relativedelta import TU, TH
from django.conf import settings
from django.utils import timezone
from .facility import Facility
from .models import Holiday
Holiday.objects.create(
name='Id-ul-Adha (Feast of the Sacrifice)',
date=date(2015, 9, 24)
)
suggested_datetime = timezone.make_aware(datetime(2015, 9, 24), timezone=pytz.utc) # TH
available_datetime = facility.available_datetime(suggested_datetime)
print(available_datetime) # 2015-09-29 00:00:00, TU
The maximum number of possible scheduling slots per day is configured in ``app_config``. As with the holiday example above, the appointment date will be incremented forward to a day with an available slot.
.. |pypi| image:: https://img.shields.io/pypi/v/edc-facility.svg
:target: https://pypi.python.org/pypi/edc-facility
.. |travis| image:: https://travis-ci.org/clinicedc/edc-facility.svg?branch=develop
:target: https://travis-ci.org/clinicedc/edc-facility
.. |codecov| image:: https://codecov.io/gh/clinicedc/edc-facility/branch/develop/graph/badge.svg
:target: https://codecov.io/gh/clinicedc/edc-facility
.. |downloads| image:: https://pepy.tech/badge/edc-facility
:target: https://pepy.tech/project/edc-facility
Project details
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
Built Distribution
Close
Hashes for edc-facility-0.1.10.macosx-10.7-x86_64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37a51e3b69a1ab15694ac15ca26080f34878063568471459367cb1db5d1ba08f |
|
MD5 | cc40ad371ebcb1747cc676449e0411c3 |
|
BLAKE2b-256 | ee5e0020b51008a79ddf2dcf4d3dffe867bc94328b9842d4808f10605076db96 |
Close
Hashes for edc_facility-0.1.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89b2f1abc21871d17b3febed11e0225539457b4fdee6199d5bec61ef236d0c81 |
|
MD5 | 0994da8f53bd28c285c45d496a8b5e7e |
|
BLAKE2b-256 | dbafd981044d38a1574be0d2d9b031a9fbbff8ca2a02ba9274dafd5bb186a75d |