Permalink
Browse files

Updated docs for demo setup with virtualenv

  • Loading branch information...
1 parent c6212c7 commit 57cb4938a6363b0adbe9bc0ffcff86dc98c83f6b @dakrauth committed Mar 22, 2013
Showing with 100 additions and 8,376 deletions.
  1. +1 −0 .gitignore
  2. +0 −4 docs/build/html/.buildinfo
  3. +0 −15 docs/build/html/_sources/changes.txt
  4. +0 −22 docs/build/html/_sources/contents.txt
  5. +0 −172 docs/build/html/_sources/forms.txt
  6. +0 −27 docs/build/html/_sources/index.txt
  7. +0 −147 docs/build/html/_sources/intro.txt
  8. +0 −211 docs/build/html/_sources/models.txt
  9. +0 −59 docs/build/html/_sources/swingtime_settings.txt
  10. +0 −114 docs/build/html/_sources/utils.txt
  11. +0 −171 docs/build/html/_sources/views.txt
  12. BIN docs/build/html/_static/ajax-loader.gif
  13. +0 −540 docs/build/html/_static/basic.css
  14. BIN docs/build/html/_static/comment-bright.png
  15. BIN docs/build/html/_static/comment-close.png
  16. BIN docs/build/html/_static/comment.png
  17. BIN docs/build/html/_static/contents.png
  18. +0 −256 docs/build/html/_static/default.css
  19. +0 −247 docs/build/html/_static/doctools.js
  20. BIN docs/build/html/_static/down-pressed.png
  21. BIN docs/build/html/_static/down.png
  22. BIN docs/build/html/_static/file.png
  23. +0 −154 docs/build/html/_static/jquery.js
  24. BIN docs/build/html/_static/minus.png
  25. BIN docs/build/html/_static/navigation.png
  26. BIN docs/build/html/_static/plus.png
  27. +0 −62 docs/build/html/_static/pygments.css
  28. +0 −16 docs/build/html/_static/rightsidebar.css
  29. +0 −560 docs/build/html/_static/searchtools.js
  30. +0 −151 docs/build/html/_static/sidebar.js
  31. +0 −557 docs/build/html/_static/sphinxdoc.css
  32. +0 −19 docs/build/html/_static/stickysidebar.css
  33. +0 −700 docs/build/html/_static/traditional.css
  34. +0 −23 docs/build/html/_static/underscore.js
  35. BIN docs/build/html/_static/up-pressed.png
  36. BIN docs/build/html/_static/up.png
  37. +0 −808 docs/build/html/_static/websupport.js
  38. +0 −130 docs/build/html/changes.html
  39. +0 −151 docs/build/html/contents.html
  40. +0 −368 docs/build/html/forms.html
  41. +0 −620 docs/build/html/genindex.html
  42. +0 −228 docs/build/html/index.html
  43. +0 −275 docs/build/html/intro.html
  44. +0 −385 docs/build/html/models.html
  45. +0 −120 docs/build/html/modindex.html
  46. +0 −7 docs/build/html/objects.inv
  47. +0 −150 docs/build/html/py-modindex.html
  48. +0 −105 docs/build/html/search.html
  49. +0 −1 docs/build/html/searchindex.js
  50. +0 −199 docs/build/html/swingtime_settings.html
  51. +0 −249 docs/build/html/utils.html
  52. +0 −296 docs/build/html/views.html
  53. +3 −1 docs/source/conf.py
  54. +1 −0 docs/source/index.txt
  55. +83 −0 docs/source/installation.txt
  56. +0 −56 docs/source/intro.txt
  57. +12 −0 docs/source/swingtime_settings.txt
View
@@ -3,3 +3,4 @@
*.pyc
karate.db
demo/django
+docs/build
@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d2c72c715dcc46327956e9c5d1800125
-tags: fbb0d17656682115ca4d033fb2f83ba1
@@ -1,15 +0,0 @@
-.. _changes:
-
-Changes in Swingtime
-====================
-
-Release 0.2.2 (March 16, 2013)
-------------------------------
-
-* Registered in PyPI
-* Installs with `pip`
-
-Release 0.2 (Decemeber 18, 2008)
---------------------------------
-
-* First public release.
@@ -1,22 +0,0 @@
-.. _contents:
-
-Table of Contents
-=================
-
-.. toctree::
- :maxdepth: 2
-
- models
- views
- forms
- utils
- swingtime_settings
-
-
-Index
-=====
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
@@ -1,172 +0,0 @@
-================================
-:mod:`forms` --- Swingtime Forms
-================================
-
-.. module:: forms
-
-Convenience forms for adding and updating ``Event`` and ``Occurrence`` objects.
-
-Functions
-=========
-
-``timeslot_options``
---------------------
-
-.. function:: timeslot_options([interval=swingtime_settings.TIMESLOT_INTERVAL, start_time=swingtime_settings.TIMESLOT_START_TIME, end_delta=swingtime_settings.TIMESLOT_END_TIME_DURATION, fmt=swingtime_settings.TIMESLOT_TIME_FORMAT])
-
- Create a list of time slot options for use in swingtime forms.
-
- The list is comprised of 2-tuples containing a 24-hour time value and a
- 12-hour temporal representation of that offset.
-
-``timeslot_offset_options``
----------------------------
-
-.. function:: timeslot_offset_options([interval=swingtime_settings.TIMESLOT_INTERVAL, start_time=swingtime_settings.TIMESLOT_START_TIME, end_delta=swingtime_settings.TIMESLOT_END_TIME_DURATION, fmt=swingtime_settings.TIMESLOT_TIME_FORMAT])
-
- Create a list of time slot options for use in swingtime forms.
-
- The list is comprised of 2-tuples containing the number of seconds since the
- start of the day and a 12-hour temporal representation of that offset.
-
-Data
-====
-
-``default_timeslot_options``
-----------------------------
-
-.. data:: default_timeslot_options
-
- defaults to ``timeslot_options()``
-
-``default_timeslot_offset_options``
------------------------------------
-
-.. data:: default_timeslot_offset_options
-
- defaults to ``timeslot_offset_options()``
-
-
-Classes
-=======
-
-``MultipleIntegerField``
-------------------------
-
-.. class:: MultipleIntegerField(django.forms.MultipleChoiceField)
-
- A form field for handling multiple integers.
-
- def __init__(self, choices, size=None, label=None, widget=None):
- if widget is None:
- widget = forms.SelectMultiple(attrs={'size' : size or len(choices)})
-
-
-``SplitDateTimeWidget``
------------------------
-
-.. class:: SplitDateTimeWidget(django.forms.MultiWidget)
-
- A Widget that splits datetime input into a SelectDateWidget for dates and
- Select widget for times.
-
- .. method:: __init__(attrs=None)
-
- uses widgets ``SelectDateWidget`` and
- ``forms.Select(choices=default_timeslot_options``
-
-``MultipleOccurrenceForm``
---------------------------
-
-.. class:: MultipleOccurrenceForm(django.forms.Form)
-
- .. attribute:: day
-
- forms.DateField
-
- .. attribute:: start_time_delta
-
- forms.IntegerField
-
- .. attribute:: end_time_delta
-
- forms.IntegerField
-
- .. attribute:: repeats
-
- forms.ChoiceField
-
- .. attribute:: count
-
- forms.IntegerField
-
- .. attribute:: until
-
- forms.DateField
-
- .. attribute:: freq
-
- forms.IntegerField
-
- .. attribute:: interval
-
- forms.IntegerField
-
- .. attribute:: week_days
-
- MultipleIntegerField
-
- .. attribute:: month_ordinal
-
- forms.IntegerField
-
- .. attribute:: month_ordinal_day
-
- forms.IntegerField
-
- .. attribute:: each_month_day = MultipleIntegerField(
-
- .. attribute:: year_months
-
- MultipleIntegerField
-
- .. attribute:: is_year_month_ordinal
-
- forms.BooleanField(required=False)
-
- .. attribute:: year_month_ordinal
-
- forms.IntegerField(widget=forms.Select(choices=ORDINAL))
-
- .. attribute:: year_month_ordinal_day
-
- forms.IntegerField(widget=forms.Select(choices=WEEKDAY_LONG))
-
- .. method:: __init__([*args, **kws])
-
- if ``initial`` contains ``dtstart`` - a ``datetime.datetime`` instance -
- the appropriate unspecified ``initial`` will be defaulted for the
- form.
-
- .. method:: clean()
-
- populates ``cleaned_data`` with ``start_time`` and ``end_time`` values
-
- .. method:: save(event):
-
- Returns an ``Event`` object
-
-``EventForm``
--------------
-
-.. class:: EventForm(django.forms.ModelForm)
-
- A simple form for adding and updating Event attributes
-
-``SingleOccurrenceForm``
-------------------------
-
-.. class:: SingleOccurrenceForm(django.forms.ModelForm)
-
- A simple form for adding and updating single Occurrence attributes
-
@@ -1,27 +0,0 @@
-.. _index:
-
-Swingtime documentation contents
-================================
-
-Table of Contents
------------------
-
-.. toctree::
- :maxdepth: 3
-
- intro
- models
- views
- forms
- utils
- swingtime_settings
- changes
-
-
-Index
------
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
@@ -1,147 +0,0 @@
-============
-Introduction
-============
-
-About Swingtime
-===============
-
-Welcome
--------
-
-Swingtime is a `Django <http://www.djangoproject.com/>`_ application similar to
-a stripped-down version of `iCal for Mac OS X <http://en.wikipedia.org/wiki/ICal>`_
-or `Google Calendar <http://www.google.com/intl/en/googlecalendar/tour.html>`_.
-Swingtime provides a :class:`~models.Event` model that acts as metadata container
-for one or more :class:`~models.Occurrence` objects, which describe specific
-start and end times.
-
-Swingtime relies heavily upon both the ``datetime`` standard library package and
-the ``dateutil`` package, featuring direct support for the ``dateutil.rrule``
-interface to create occurrences.
-
-A fairly simple example::
-
- >>> from datetime import *
- >>> from swingtime import models as swingtime
- >>> et = swingtime.EventType.objects.create(abbr='work', label='Work Related Events')
- >>> evt = swingtime.Event.objects.create(
- ... title='New TPS Cover Sheet',
- ... description='Kiss off, Lumbergh!',
- ... event_type=et
- ... )
- >>> evt.add_occurrences(datetime(2013,4,1,16), datetime(2013,4,1,16,15), count=5)
- >>> for o in evt.occurrence_set.all():
- ... print o
- ...
- New TPS Cover Sheet: 2013-04-01T16:00:00
- New TPS Cover Sheet: 2013-04-02T16:00:00
- New TPS Cover Sheet: 2013-04-03T16:00:00
- New TPS Cover Sheet: 2013-04-04T16:00:00
- New TPS Cover Sheet: 2013-04-05T16:00:00
-
-A bit more elaborate example, using the the convenience function :func:`models.create_event`::
-
- >>> # pay day is the last Friday of the month at 5pm
- >>> evt = swingtime.create_event(
- ... 'Pay day',
- ... ('pay', 'Payroll'), # alternate means to add EventType on the fly
- ... freq=rrule.MONTHLY,
- ... byweekday=rrule.FR(-1),
- ... until=datetime(2013,8,1),
- ... start_time=datetime(2013,4,1,17)
- ... )
- >>> for o in evt.occurrence_set.all():
- ... print o
- ...
- Pay day: 2013-04-26T17:00:00
- Pay day: 2013-05-31T17:00:00
- Pay day: 2013-06-28T17:00:00
- Pay day: 2013-07-26T17:00:00
-
-
-Features
---------
-
-* Support for adding complex event occurrences via ``dateutil``
-* Ready-made :class:`~forms.MultipleOccurrenceForm` for handling complex input
-* Daily, monthly, and annual view functions
-* Grid-based daily view generator, complete with alternating or sequential
- :class:`~models.EventType` CSS-class handling
-* Slightly better than average documentation, a few test cases, and commented code
-* Active support (I have to eat my own dogfood)
-* Built-in demo project / application
-
-Requirements
-------------
-
-* `Django 1.4+ <http://www.djangoproject.com/download/>`_
-* Python 2.7
-* The ``dateutil`` `package <http://labix.org/python-dateutil>`_.
-
-Get Swingtime
--------------
-
-Options:
-
-* `Swingtime source code <https://github.com/dakrauth/django-swingtime>`_
-* ``pip install django-swingtime``
-
-Settings
---------
-
-Swingtime has it's settings module (:file:`conf/swingtime_settings.py`) that
-simulates how each Django project's :file:`setting.py` file functions. You can
-overwrite any or all of the configuration parameters described in
-:mod:`swingtime_settings` by creating a file in your own project and referencing
-that file in your project settings using the name :data:`SWINGTIME_SETTINGS_MODULE`.
-
-For example, from the demo's configuration::
-
- SWINGTIME_SETTINGS_MODULE = 'demo.swingtime_settings'
-
-
-Demo
-====
-
-Swingtime comes with its own demo project and application. The demo is themed as
-a Karate studio's website and allows you see and interact with the Swingtime
-application.
-
-Run locally using the `built-in Django development server
-<http://docs.djangoproject.com/en/dev/ref/django-admin/#runserver-optional-port-number-or-ipaddr-port>`_.
-
-Templates
----------
-
-Currently, Swingtime does not include any templates of its own. The demo project
-provides some sample templates to use as a guide or starting point.
-
-Sample data
------------
-
-Within the Swingtime demo is an app named ``karate``, which defines the custom
-management command ``loaddemo``. This command will pre-populate your
-initial database with some events and occurrences based upon the current date and
-time.
-
-Running the demo
-----------------
-
-If you've checked out from directly from the trunk directory or exploded the
-latest version tarball, you run the demo from anywhere by changing to the
-``demo`` directory and running::
-
- $ python manage.py loaddemo
- $ python manage.py runserver
-
-
-Todo List
-=========
-
-* Add i18n support / translation support in demo
-* Include a setup installer (I'm not doing ``easy_install``!)
-* Add weekly view
-* Import and export .ics files
-* Add :class:`~models.Note` support to demo
-* Add more tests
-* Port over to github
Oops, something went wrong.

0 comments on commit 57cb493

Please sign in to comment.