Installation

Note

The swingtime documentation assumes familiarity with and installation of Python deployment tools pip, virtualenv, and virtualenvwrapper.

Get Swingtime

Basic Installation

Install into the current environment:

$ pip install django-swingtime

Development

Setup a virtual environment:

$ mkvirtualenv swingtime
$ pip install invoke

Get the code:

  • git:

    $ git clone https://github.com/dakrauth/django-swingtime.git django-swingtime
    $ cd django-swingtime
    
  • Download:

    $ curl -o swingtime.zip -L https://github.com/dakrauth/django-swingtime/archive/master.zip
    $ unzip swingtime.zip
    $ cd django-swingtime-master
    

Invoke is used to automate many tasks. See inv -l for all options.:

$ inv dev

Documentation

Note

Building the documentation requires Sphinx to be installed.

First, install the swingtime project as shown in Development.:

$ inv docs

Browse the file docs/index.html.

Running the Tests

First, install the swingtime project as shown in Development.:

$ inv test