Bird colony management tool
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
birds
scripts
.gitignore
COPYING
MANIFEST.in
README.md
requirements.txt
setup.cfg
setup.py

README.md

bird-colony

bird-colony is a Django application used to manage bird colonies (including breeding colonies). You may find that it can also be used for non-avian species.

The admin interface is the primary tool used to create and update bird records, but there is a growing collection of views that can be used to browse the database and perform common updates (like adding clutches). There is also a JSON API that supports a variety of search queries.

bird-colony is licensed for you to use under the Gnu Public License, version 3. See COPYING for details

Quick start

You'll need to have a basic understanding of how to use Django.

  1. Install the package using pip: pip install django-bird-colony. Worth putting in a virtualenv.

  2. Add birds and some dependencies to your INSTALLED_APPS setting like this:

INSTALLED_APPS = (
    ...
    'rest_framework',
    'django_filters',
    'birds',
)
  1. Include the birds URLconf in your project urls.py like this::
url(r'^birds/', include('birds.urls', namespace='birds'))
  1. Run python manage.py migrate to create the birds models.

  2. Start the development server and visit http://127.0.0.1:8000/admin/birds/ to create birds, events, etc. (you'll need the Admin app enabled).

  3. Visit http://127.0.0.1:8000/birds/ to use views.

Make sure to consult the Django documentation on deployment if you are at all concerned about security.

Changelog

In the 0.4.0 release, the primary key for animal records became the animal's uuid. To migrate from previous version, data must be exported as JSON under the 0.3.999 release and then imported under 0.4.0