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. There's also support for storing information about samples associated with animals in the colony, like genomic DNA or song recordings.
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
You'll need to have a basic understanding of how to use Django.
Install the package using pip:
pip install django-bird-colony. Worth putting in a virtualenv.
birdsand some dependencies to your INSTALLED_APPS setting like this:
INSTALLED_APPS = ( ... 'rest_framework', 'django_filters', 'birds', )
- Include the birds URLconf in your project urls.py like this::
python manage.py migrateto create the database tables. If this is a new django install, run
python migrate.py createsuperuserto create your admin user.
python manage.py loaddata bird_colony_starter_kitto create some useful initial records.
Start the development server (
python manage.py runserver) and visit http://127.0.0.1:8000/admin/birds/ to set up your colony, as described in the next section.
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.
This is a work in progress. Before you start entering birds and events, you need to set up some tables using the Django admin app.
- Edit species records in the
bird_colony_starter_kitfixture will create a record for zebra finches. The
codefield is used to give animals their names, so if you have zebra finches and use
zebfas your code, your birds will be named
zebf_red_1and so forth.
- Edit and add locations to the
Locationstable. You need to have at least one location created. The main use for this field is to allow you to find where a bird is by looking at the last event.
- Edit and create new event types in the
Status codestable. Common event types include
used for anatomy, etc. For each status code, indicate whether it adds or removes a bird from the colony. When you create an event that removes a bird, it will appear as no longer alive. The
hatchedevent is special, because if you add a bird to the database using the
Add new birdview using this code, the system will require you to enter the bird's parents. (If you don't know the bird's parents, you can always create it manually in the admin interface)
- If your bands are colored, add your colors to the
Colorstable. This will affect the short name for your animals.
- If you're going to be adding samples to the databse, add or edit
Sample typesin the admin interface.
- Add additional users to the database. This is particularly useful if you want to allow specific users to reserve animals.
- If you want to change some of the boilerplate text on the entry forms, you'll need to install the app from source. The templates are found under
birds/templates/birdsin the source directory.
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