eBird Notebooks

eBird Notebooks brings together Django and Jupyter Lab to create an easy to use platform for analysing data from eBird.

Features

• Load checklists from the eBird API

Quickstart

Download and unzip the code.

cd ebird-notebooks

Create the virtual environment:

uv venv

Activate it:

source .venv/bin/activate

Install the project requirements:

 uv sync

Create a copy of the example .env file and edit it to add your eBird API key:

 cp .env.example .env

Create the database tables:

 python manage.py migrate

Start Jupyter Lab:

python manage.py shell_plus --notebook

Finally, open up the Getting Started notebook and run all cells.

Django Admin

THe great thing about Django is the batteries-included philosophy, and, in particular, the Django Admin which allows you to browse and edit the data in the database.

To use the Django Admin, create a user account (with superpowers):

python manage.py createsuperuser

Now run the django server:

python manage.py runserver

Open a new tab on your browser, visit http://localhost:8000/admin/, log in using the newly created superuser account. When you run the cells in the Getting Started notebook you can then browse the data loaded into the tables.

Project Information

• Issues: https://todo.sr.ht/~smackay/ebird-notebooks
• Repository: https://git.sr.ht/~smackay/ebird-notebooks
• Announcements: https://lists.sr.ht/~smackay/ebirders-announce
• Discussions: https://lists.sr.ht/~smackay/ebirders-discuss
• Development: https://lists.sr.ht/~smackay/ebirders-develop

The repository is also mirrored on Github:

• Repository: https://github.com/StuartMacKay/ebird-notebooks

License

The project is made available under the terms of the MIT license.