https://github.com/tswicegood/d51.django.apps.schedules

Simple, reusable Django application for handling scheduling models for display.
https://github.com/tswicegood/d51.django.apps.schedules

Last synced: 12 days ago
JSON representation

Simple, reusable Django application for handling scheduling models for display.

• Host: GitHub
• URL: https://github.com/tswicegood/d51.django.apps.schedules
• Owner: tswicegood
• License: other
• Created: 2009-11-02T19:14:31.000Z (about 15 years ago)
• Default Branch: master
• Last Pushed: 2009-12-29T22:25:14.000Z (almost 15 years ago)
• Last Synced: 2024-04-14T14:50:11.894Z (7 months ago)
• Language: Python
• Homepage:
• Size: 104 KB
• Stars: 5
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.cddl

Awesome Lists containing this project

README

        
d51.django.apps.schedules

=========================

Simple, reusable Django application for handling scheduling models for display.

Usage

-----

You can use the `schedules` app to, as the name says, handle a schedule for

models.  You don't have to modify your existing models for this to work, but

you can definitely add a `schedule` property if you need to.

### `d51.django.apps.models.ScheduledItem`

The main piece of this app, the `ScheduledItem` model, uses a [generic

relationship][generic] to manage its relationship to any model.  To create

a new scheduled item:

    ScheduleItem.object.create(

        published=some_datetime_object,

        content_object=some_model

    )

You can use the `objects.available()` method to grab all ScheduledItems that

are available---i.e., models that have a `published` date that is equal or

before the current time.

### Filtering types of scheduled objects

You can also filter the type of objects that `available()` returns by passing

in an class.  For example, to get all of the `Post` objects that are available:

    ScheduledItems.objects.available(Post)

Of course, that returns all of the matching `ScheduledItem` models, but a more

common case is needing the explicit `Post` objects.  This provides that functionality

as well via the `return_related()` method.  For example, you can use:

    ScheduledItem.objects.return_related().available(Post)

    # Or

    ScheduledItem.objects.available(Post).return_related()

Both are functionality equivalent.

Testing

-------

The tests in `d51.django.apps.schedules` are complete self-contained.  You can

run the tests from within any Django project by executing the standard test

command:

    python manage.py test schedules

You can also test directly within the repository using [virtualenv][] and

[pip][].  The rest of this section assumes you're interested in testing in

isolation, outside of a full project.

### Initializing the test environment

First, you must initialize a virtual environment:

    virtualenv .

Next, you need to install Django (if you don't have it installed already),

which is listed in the `requirements.txt` file.  You can install the necessary

version directly into the virtual environment using the `-E .` parameter:

    pip install -E . -r requirements.txt

### Initializing with Fabric

These steps can be run for you with [fabric][].  The `fabfile.py` included with

this repository has been tested with 1.0a and may not be backwards compatible.

To initialize using Fabric, you can run:

    fab init

### Activating test environment

You must activate the virtual environment if it contains your only copy of Django.

You can do this by running:

    source ./bin/activate

Your prompt should change to not that you are now running inside the virtual

environment.  Now you're ready to run the tests.

### Running the tests

There are two ways to run the tests.  The most straight forward with the output

you've come to expect from a Django test runner is the `run_tests.py` file.

Simply run:

    python run_tests.py

You can also run the tests using Fabric, though the output is much more

subdued.

    fab test

### Cleaning the test environment

A complete copy of Django, along with the tools necessary for virtualenv are

installed using this method.  Once you are finished testing, you can remove all

of the generated files with Fabric by running the following command:

    fab clean

*Warning*: You must re-run the initialization steps if in order to run the

tests again if you run the `clean` task.

[generic]: http://www.djangoproject.com/documentation/models/generic_relations/

[virtualenv]: http://virtualenv.openplans.org/

[pip]: http://pip.openplans.org/

[fabric]: http://docs.fabfile.org/