<commit_before>Django Booking
============

A reusable Django app that manages bookings for various purposes.

Installation
------------

To get the latest stable release from PyPi

.. code-block:: bash

    $ pip install django-booking

To get the latest commit from GitHub

.. code-block:: bash

    $ pip install -e git+git://github.com/bitmazk/django-booking.git#egg=booking

TODO: Describe further installation steps (edit / remove the examples below):

Add ``booking`` to your ``INSTALLED_APPS``

.. code-block:: python

    INSTALLED_APPS = (
        ...,
        'booking',
    )

Add the ``booking`` URLs to your ``urls.py``

.. code-block:: python

    urlpatterns = patterns('',
        ...
        url(r'^booking/', include('booking.urls')),
    )

Don't forget to migrate your database

.. code-block:: bash

    ./manage.py migrate booking


Usage
-----

If you allow anonymous bookings, the session object is stored within the
booking model. Otherwise it will be connected to the User model.

NOTE: If a session is destroyed, the connected booking model will also be
removed.

Settings
--------

BOOKING_STATUS_CREATED
++++++++++++++++++++++

Default: 'pending'

Slug of the ``BookingStatus``, which should be added after booking creation.

BOOKING_TIME_INTERVAL
+++++++++++++++++++++

Default: ''

The default value for the ``time_unit`` attribute of the Booking. Set it in
case you need to specify that you want to book something e.g. X days or Y
hours.

Contribute
----------

If you want to contribute to this project, please perform the following steps

.. code-block:: bash

    # Fork this repository
    # Clone your fork
    $ mkvirtualenv -p python2.7 django-booking
    $ python setup.py install
    $ pip install -r dev_requirements.txt<commit_msg>Added hint to set unit setting to singular.<commit_after>Django Booking
============

A reusable Django app that manages bookings for various purposes.

Installation
------------

To get the latest stable release from PyPi

.. code-block:: bash

    $ pip install django-booking

To get the latest commit from GitHub

.. code-block:: bash

    $ pip install -e git+git://github.com/bitmazk/django-booking.git#egg=booking

TODO: Describe further installation steps (edit / remove the examples below):

Add ``booking`` to your ``INSTALLED_APPS``

.. code-block:: python

    INSTALLED_APPS = (
        ...,
        'booking',
    )

Add the ``booking`` URLs to your ``urls.py``

.. code-block:: python

    urlpatterns = patterns('',
        ...
        url(r'^booking/', include('booking.urls')),
    )

Don't forget to migrate your database

.. code-block:: bash

    ./manage.py migrate booking


Usage
-----

If you allow anonymous bookings, the session object is stored within the
booking model. Otherwise it will be connected to the User model.

NOTE: If a session is destroyed, the connected booking model will also be
removed.

Settings
--------

BOOKING_STATUS_CREATED
++++++++++++++++++++++

Default: 'pending'

Slug of the ``BookingStatus``, which should be added after booking creation.

BOOKING_TIME_INTERVAL
+++++++++++++++++++++

Default: ''

The default value for the ``time_unit`` attribute of the Booking. Set it in
case you need to specify that you want to book something e.g. X days or Y
hours. Set it to the singular of that time unit:::

   BOOKING_TIME_INTERVAL = 'day'

Contribute
----------

If you want to contribute to this project, please perform the following steps

.. code-block:: bash

    # Fork this repository
    # Clone your fork
    $ mkvirtualenv -p python2.7 django-booking
    $ python setup.py install
    $ pip install -r dev_requirements.txt
{'fraction_non_alphanumeric': 0.13039912520503008, 'fraction_numerical': 0.0010934937124111536, 'mean_word_length': 3.125140924464487, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7092190', 'n_tokens_mistral': 1102, 'n_tokens_neox': 1042, 'n_words': 417}