ebird-api-data 0.2.0__tar.gz → 0.2.1__tar.gz

ebird_api_data-0.2.1/PKG-INFO

@@ -0,0 +1,179 @@
+Metadata-Version: 2.4
+Name: ebird-api-data
+Version: 0.2.1
+Summary: eBird API Data is a reusable Django app for loading data from eBird into a database.
+Author-email: Stuart MacKay <smackay@flagstonesoftware.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: Django,checklists,eBird,models,observations,species
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4>=4.13.3
+Requires-Dist: django>=4.2
+Requires-Dist: ebird-api-requests>=4.0.1
+Requires-Dist: ebird-codes>=0.0.2
+Requires-Dist: lxml>=6.0.0
+Description-Content-Type: text/markdown
+
+# eBird API Data
+
+eBird API Data is a reusable Django app for loading data from eBird into a database.
+
+## Overview
+
+The Cornell Laboratory of Ornithology in Ithaca, New York runs the eBird database
+which collects observations of birds from all over the world. All the observations
+are published on [eBird.org](https://ebird.org), and they also make them available
+via an [API](https://documenter.getpostman.com/view/664302/S1ENwy59). This project
+contains a loader and models to take data from the API and load it into a database.
+From there you can analyse the data with python, jupyter notebooks, or build a web
+site.
+
+To get started, you will need to
+[sign up](https://secure.birds.cornell.edu/identity/account/create)
+for an eBird account, if you don't already have one and
+[register](https://ebird.org/data/download)
+to get an API key. Make sure you read and understand the
+[Terms of use](https://www.birds.cornell.edu/home/ebird-api-terms-of-use/),
+and remember bandwidth and servers cost money, so don't abuse the service. If you
+need large numbers of observations, then sign up to receive the
+[eBird Basic Dataset](https://science.ebird.org/en/use-ebird-data/download-ebird-data-products).
+
+## Install
+
+You can use either [pip](https://pip.pypa.io/en/stable/) or [uv](https://docs.astral.sh/uv/)
+to download the [package](https://pypi.org/project/ebird-api-data/) from PyPI and
+install it into a virtualenv:
+
+```shell
+pip install ebird-api-data
+```
+
+or:
+
+```shell
+uv add ebird-api-data
+```
+
+Update `INSTALLED_APPS` in your Django setting:
+
+```python
+INSTALLED_APPS = [
+    ...
+    ebird.api.data
+]
+```
+
+Finally, run the migrations to create the tables:
+
+```python
+python manage.py migrate
+```
+
+## Demo
+
+If you check out the code from the repository there is a fully functioning
+Django site. It contains pages for checklists, observations and species,
+where you can browse the records or search by location, observer. date. etc. 
+The Django Admin lets you browse and edit the records in the database.
+
+```shell
+git clone git@github.com:StuartMacKay/ebird-api-data.git
+cd ebird-api-data
+```
+
+Create the virtual environment:
+```shell
+uv venv
+```
+
+Activate it:
+```shell
+source .venv/bin/activate
+```
+
+Install the requirements:
+```shell
+uv sync
+```
+
+Create a copy of the .env.example file and add your API key:
+```shell
+cp .env.example .env
+```
+
+For example:
+```shell
+EBIRD_API_KEY=<my api key>
+```
+
+Run the database migrations:
+```shell
+python manage.py migrate
+```
+
+Create a user:
+```shell
+python manage.py createsuperuser
+```
+
+Create a copy of the .env.example file and add your API key:
+```shell
+cp .env.example .env
+```
+
+```shell
+EBIRD_API_KEY=<my api key>
+```
+
+Now, download data from the API:
+
+```shell
+python manage.py add_checklists --days 2 US-NY-109
+```
+
+This loads all the checklists, submitted in the past two days by birders in
+Tompkins County, New York, where the Cornell Lab is based. You can use any
+location code used by eBird, whether it's for a country, state/region, or
+county. Remember, read the terms of use.
+
+Run the demo:
+
+```shell
+python manage.py runserver
+```
+
+Now, either visit the site, http:localhost:8000/, or log into the Django Admin, 
+http:localhost:8000/admin to browse the tables.
+
+## Project Information
+
+* Documentation: https://ebird-api-data.readthedocs.io/en/latest/
+* Issues: https://todo.sr.ht/~smackay/ebird-api-data
+* Repository: https://git.sr.ht/~smackay/ebird-api-data
+* 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-api-data
+
+The app is tested on Python 3.10+, and officially supports Django 4.2, 5.0 and 5.1.
+
+## License
+
+eBird API Data is released under the terms of the [MIT](https://opensource.org/licenses/MIT) license.

ebird_api_data-0.2.1/README.md

@@ -0,0 +1,149 @@
+# eBird API Data
+
+eBird API Data is a reusable Django app for loading data from eBird into a database.
+
+## Overview
+
+The Cornell Laboratory of Ornithology in Ithaca, New York runs the eBird database
+which collects observations of birds from all over the world. All the observations
+are published on [eBird.org](https://ebird.org), and they also make them available
+via an [API](https://documenter.getpostman.com/view/664302/S1ENwy59). This project
+contains a loader and models to take data from the API and load it into a database.
+From there you can analyse the data with python, jupyter notebooks, or build a web
+site.
+
+To get started, you will need to
+[sign up](https://secure.birds.cornell.edu/identity/account/create)
+for an eBird account, if you don't already have one and
+[register](https://ebird.org/data/download)
+to get an API key. Make sure you read and understand the
+[Terms of use](https://www.birds.cornell.edu/home/ebird-api-terms-of-use/),
+and remember bandwidth and servers cost money, so don't abuse the service. If you
+need large numbers of observations, then sign up to receive the
+[eBird Basic Dataset](https://science.ebird.org/en/use-ebird-data/download-ebird-data-products).
+
+## Install
+
+You can use either [pip](https://pip.pypa.io/en/stable/) or [uv](https://docs.astral.sh/uv/)
+to download the [package](https://pypi.org/project/ebird-api-data/) from PyPI and
+install it into a virtualenv:
+
+```shell
+pip install ebird-api-data
+```
+
+or:
+
+```shell
+uv add ebird-api-data
+```
+
+Update `INSTALLED_APPS` in your Django setting:
+
+```python
+INSTALLED_APPS = [
+    ...
+    ebird.api.data
+]
+```
+
+Finally, run the migrations to create the tables:
+
+```python
+python manage.py migrate
+```
+
+## Demo
+
+If you check out the code from the repository there is a fully functioning
+Django site. It contains pages for checklists, observations and species,
+where you can browse the records or search by location, observer. date. etc. 
+The Django Admin lets you browse and edit the records in the database.
+
+```shell
+git clone git@github.com:StuartMacKay/ebird-api-data.git
+cd ebird-api-data
+```
+
+Create the virtual environment:
+```shell
+uv venv
+```
+
+Activate it:
+```shell
+source .venv/bin/activate
+```
+
+Install the requirements:
+```shell
+uv sync
+```
+
+Create a copy of the .env.example file and add your API key:
+```shell
+cp .env.example .env
+```
+
+For example:
+```shell
+EBIRD_API_KEY=<my api key>
+```
+
+Run the database migrations:
+```shell
+python manage.py migrate
+```
+
+Create a user:
+```shell
+python manage.py createsuperuser
+```
+
+Create a copy of the .env.example file and add your API key:
+```shell
+cp .env.example .env
+```
+
+```shell
+EBIRD_API_KEY=<my api key>
+```
+
+Now, download data from the API:
+
+```shell
+python manage.py add_checklists --days 2 US-NY-109
+```
+
+This loads all the checklists, submitted in the past two days by birders in
+Tompkins County, New York, where the Cornell Lab is based. You can use any
+location code used by eBird, whether it's for a country, state/region, or
+county. Remember, read the terms of use.
+
+Run the demo:
+
+```shell
+python manage.py runserver
+```
+
+Now, either visit the site, http:localhost:8000/, or log into the Django Admin, 
+http:localhost:8000/admin to browse the tables.
+
+## Project Information
+
+* Documentation: https://ebird-api-data.readthedocs.io/en/latest/
+* Issues: https://todo.sr.ht/~smackay/ebird-api-data
+* Repository: https://git.sr.ht/~smackay/ebird-api-data
+* 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-api-data
+
+The app is tested on Python 3.10+, and officially supports Django 4.2, 5.0 and 5.1.
+
+## License
+
+eBird API Data is released under the terms of the [MIT](https://opensource.org/licenses/MIT) license.

{ebird_api_data-0.2.0 → ebird_api_data-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ebird-api-data"
-version = "0.2.0"
+version = "0.2.1"
 description = "eBird API Data is a reusable Django app for loading data from eBird into a database."
 keywords = ["checklists", "observations", "species", "Django", "eBird", "models"]
 license = "MIT"
@@ -8,7 +8,7 @@ license-files = ["LICENSE"]
 authors = [
   {name = "Stuart MacKay", email = "smackay@flagstonesoftware.com"},
 ]
-readme = "README.rst"
+readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
     "beautifulsoup4>=4.13.3",
@@ -61,10 +61,11 @@ dev-dependencies = [
     "django-extensions>=3.2.3",
     "psycopg2-binary>=2.9.10",
     "ipython>=8.37.0",
+    "django-autocomplete-light>=3.12.1",
 ]
 
 [tool.bumpversion]
-current_version = "0.2.0"
+current_version = "0.2.1"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 ignore_missing_version = false
@@ -89,16 +90,15 @@ search = 'release = "{current_version}"'
 replace = 'release = "{new_version}"'
 
 [[tool.bumpversion.files]]
-filename = "CHANGELOG.rst"
+filename = "CHANGELOG.md"
 search = """
-Latest
-------"""
+## Latest
+"""
 replace = """
-Latest
-------
+## Latest
 
-{new_version} ({now:%Y-%m-%d})
-------------------"""
+## {new_version}
+"""
 
 [[tool.bumpversion.files]]
 filename = "pyproject.toml"

ebird_api_data-0.2.1/src/ebird/api/data/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.1"

{ebird_api_data-0.2.0 → ebird_api_data-0.2.1}/src/ebird/api/data/loaders.py

@@ -318,12 +318,10 @@ class APILoader:
                 created = False
             else:
                 identifier = self.get_observer_identifier(data)
-                observer = Observer.objects.create(
+                observer, created = Observer.objects.get_or_create(
                     identifier=identifier,
-                    name=name,
-                    original=name,
+                    defaults={"name": name, "original":name,}
                 )
-                created = True
 
         if created:
             logger.info("Added observer: %s", name)

ebird_api_data-0.2.1/src/ebird/api/data/migrations/0008_rename_created_checklist_added.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.2.4 on 2025-07-17 06:10
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('data', '0007_remove_old_fields_and_ids'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='checklist',
+            old_name='created',
+            new_name='added',
+        ),
+        migrations.AlterField(
+            model_name='checklist',
+            name='added',
+            field=models.DateTimeField(blank=True, help_text='The date and time the checklist was added to eBird.', null=True, verbose_name='added'),
+        ),
+    ]

ebird_api_data-0.2.1/src/ebird/api/data/migrations/0009_add_created_timestamps.py

@@ -0,0 +1,58 @@
+# Generated by Django 5.2.4 on 2025-07-17 06:18
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('data', '0008_rename_created_checklist_added'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='checklist',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, help_text='When was the record created.', null=True),
+        ),
+        migrations.AddField(
+            model_name='country',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, help_text='When was the record created.', null=True),
+        ),
+        migrations.AddField(
+            model_name='county',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, help_text='When was the record created.', null=True),
+        ),
+        migrations.AddField(
+            model_name='filter',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, help_text='When was the record created.', null=True),
+        ),
+        migrations.AddField(
+            model_name='location',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, help_text='When was the record created.', null=True),
+        ),
+        migrations.AddField(
+            model_name='observation',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, help_text='When was the record created.', null=True),
+        ),
+        migrations.AddField(
+            model_name='observer',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, help_text='When was the record created.', null=True),
+        ),
+        migrations.AddField(
+            model_name='species',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, help_text='When was the record created.', null=True),
+        ),
+        migrations.AddField(
+            model_name='state',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, help_text='When was the record created.', null=True),
+        ),
+    ]

{ebird_api_data-0.2.0 → ebird_api_data-0.2.1}/src/ebird/api/data/models/checklist.py

@@ -7,11 +7,11 @@ class Checklist(models.Model):
         verbose_name = _("checklist")
         verbose_name_plural = _("checklists")
 
-    created = models.DateTimeField(
+    added = models.DateTimeField(
         blank=True,
         null=True,
         help_text=_("The date and time the checklist was added to eBird."),
-        verbose_name=_("created"),
+        verbose_name=_("added"),
     )
 
     edited = models.DateTimeField(
@@ -172,6 +172,10 @@ class Checklist(models.Model):
         blank=True,
     )
 
+    created = models.DateTimeField(
+        null=True, auto_now_add=True, help_text=_("When was the record created.")
+    )
+
     def __repr__(self) -> str:
         return str(self.identifier)
 

{ebird_api_data-0.2.0 → ebird_api_data-0.2.1}/src/ebird/api/data/models/country.py

@@ -22,6 +22,10 @@ class Country(models.Model):
         verbose_name=_("place"), help_text=_("The hierarchical name of the country.")
     )
 
+    created = models.DateTimeField(
+        null=True, auto_now_add=True, help_text=_("When was the record created.")
+    )
+
     def __repr__(self) -> str:
         return str(self.code)
 

{ebird_api_data-0.2.0 → ebird_api_data-0.2.1}/src/ebird/api/data/models/county.py

@@ -22,6 +22,10 @@ class County(models.Model):
         verbose_name=_("place"), help_text=_("The hierarchical name of the county.")
     )
 
+    created = models.DateTimeField(
+        null=True, auto_now_add=True, help_text=_("When was the record created.")
+    )
+
     def __repr__(self) -> str:
         return str(self.code)
 

{ebird_api_data-0.2.0 → ebird_api_data-0.2.1}/src/ebird/api/data/models/filter.py

@@ -48,6 +48,10 @@ class Filter(models.Model):
         help_text=_("Matching Observations are updated to this species."),
     )
 
+    created = models.DateTimeField(
+        null=True, auto_now_add=True, help_text=_("When was the record created.")
+    )
+
     def __repr__(self) -> str:
         return str(self.name)
 

{ebird_api_data-0.2.0 → ebird_api_data-0.2.1}/src/ebird/api/data/models/location.py

@@ -147,6 +147,10 @@ class Location(models.Model):
         blank=True,
     )
 
+    created = models.DateTimeField(
+        null=True, auto_now_add=True, help_text=_("When was the record created.")
+    )
+
     def __repr__(self) -> str:
         return str(self.identifier)
 

{ebird_api_data-0.2.0 → ebird_api_data-0.2.1}/src/ebird/api/data/models/observation.py

@@ -171,6 +171,10 @@ class Observation(models.Model):
         blank=True,
     )
 
+    created = models.DateTimeField(
+        null=True, auto_now_add=True, help_text=_("When was the record created.")
+    )
+
     def __repr__(self) -> str:
         return str(self.identifier)
 

{ebird_api_data-0.2.0 → ebird_api_data-0.2.1}/src/ebird/api/data/models/observer.py

@@ -43,6 +43,10 @@ class Observer(models.Model):
         blank=True,
     )
 
+    created = models.DateTimeField(
+        null=True, auto_now_add=True, help_text=_("When was the record created.")
+    )
+
     def __repr__(self) -> str:
         return str(self.identifier)
 

{ebird_api_data-0.2.0 → ebird_api_data-0.2.1}/src/ebird/api/data/models/species.py

@@ -90,6 +90,10 @@ class Species(models.Model):
         blank=True,
     )
 
+    created = models.DateTimeField(
+        null=True, auto_now_add=True, help_text=_("When was the record created.")
+    )
+
     def __repr__(self) -> str:
         return str(self.species_code)
 

{ebird_api_data-0.2.0 → ebird_api_data-0.2.1}/src/ebird/api/data/models/state.py

@@ -22,6 +22,10 @@ class State(models.Model):
         verbose_name=_("place"), help_text=_("The hierarchical name of the state.")
     )
 
+    created = models.DateTimeField(
+        null=True, auto_now_add=True, help_text=_("When was the record created.")
+    )
+
     def __repr__(self) -> str:
         return str(self.code)
 

ebird_api_data-0.2.0/PKG-INFO

@@ -1,185 +0,0 @@
-Metadata-Version: 2.4
-Name: ebird-api-data
-Version: 0.2.0
-Summary: eBird API Data is a reusable Django app for loading data from eBird into a database.
-Author-email: Stuart MacKay <smackay@flagstonesoftware.com>
-License-Expression: MIT
-License-File: LICENSE
-Keywords: Django,checklists,eBird,models,observations,species
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Framework :: Django
-Classifier: Framework :: Django :: 4.2
-Classifier: Framework :: Django :: 5.0
-Classifier: Framework :: Django :: 5.1
-Classifier: Framework :: Django :: 5.2
-Classifier: Intended Audience :: Science/Research
-Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Scientific/Engineering :: Information Analysis
-Requires-Python: >=3.10
-Requires-Dist: beautifulsoup4>=4.13.3
-Requires-Dist: django>=4.2
-Requires-Dist: ebird-api-requests>=4.0.1
-Requires-Dist: ebird-codes>=0.0.2
-Requires-Dist: lxml>=6.0.0
-Description-Content-Type: text/x-rst
-
-eBird API Data
-==============
-eBird API Data is a reusable Django app for loading data from eBird into a database.
-
-Overview
---------
-.. overview-start
-
-The Cornell Laboratory of Ornithology in Ithaca, New York runs the eBird database
-which collects observations of birds from all over the world. All the observations
-are published on `eBird.org`_, and they also make them available via an `API`_.
-This project contains a loader and models to take data from the API and load it into
-a database. From there you can analyse the data with python, jupyter notebooks, or
-build a web site.
-
-To get started, you will need to `sign up`_ for an eBird account, if you don't
-already have one and `register`_ to get an API key. Make sure you read and
-understand the `Terms of use`_, and remember bandwidth and servers cost money,
-so don't abuse the service. If you need large numbers of observations, then
-sign up to receive the `eBird Basic Dataset`_.
-
-.. _eBird.org: https://ebird.org
-.. _API: https://documenter.getpostman.com/view/664302/S1ENwy59
-.. _sign up: https://secure.birds.cornell.edu/identity/account/create
-.. _register: https://ebird.org/data/download
-.. _Terms of use: https://www.birds.cornell.edu/home/ebird-api-terms-of-use/
-.. _eBird Basic Dataset: https://science.ebird.org/en/use-ebird-data/download-ebird-data-products
-
-.. overview-end
-
-Install
--------
-.. install-start
-
-You can use either `pip`_ or `uv`_ to download the `package`_ from PyPI and
-install it into a virtualenv:
-
-.. code-block:: console
-
-    pip install ebird-api-data
-
-or:
-
-.. code-block:: console
-
-    uv add ebird-api-data
-
-Update ``INSTALLED_APPS`` in your Django setting:
-
-.. code-block:: python
-
-    INSTALLED_APPS = [
-        ...
-        ebird.api.data
-    ]
-
-Finally, run the migrations to create the tables:
-
-.. code-block:: python
-
-    python manage.py migrate
-
-.. _pip: https://pip.pypa.io/en/stable/
-.. _uv: https://docs.astral.sh/uv/
-.. _package: https://pypi.org/project/ebird-api-data/
-
-.. install-end
-
-Demo
-----
-
-.. demo-start
-
-If you check out the code from the repository there is a fully functioning
-Django site. It only contains the admin pages, but that is sufficient for
-you to browse the data.
-
-.. code-block:: console
-
-    git clone git@github.com:StuartMacKay/ebird-api-data.git
-    cd ebird-api-data
-
-Create the virtual environment:
-
-.. code-block:: console
-
-    uv venv
-
-Activate it:
-
-.. code-block:: console
-
-    source venv/bin/activate
-
-Install the requirements:
-
-.. code-block:: console
-
-    uv sync
-
-Run the database migrations:
-
-.. code-block:: console
-
-    python manage.py migrate
-
-Create a user:
-
-.. code-block:: console
-
-    python manage.py createsuperuser
-
-Create a copy of the .env.example file and add your API key:
-
-.. code-block:: console
-
-    cp .env.example .env
-
-.. code-block:: console
-
-    EBIRD_API_KEY=<my api key>
-
-Now, download data from the API:
-
-.. code-block:: console
-
-    python manage.py add_checklists --days 2 US-NY-109
-
-This loads all the checklists, submitted in the past two days by birders in
-Tompkins County, New York, where the Cornell Lab is based. You can use any
-location code used by eBird, whether it's for a country, state/region, or
-county. Remember, read the terms of use.
-
-Run the demo:
-
-.. code-block:: console
-
-    python manage.py runserver
-
-Now log into the `Django Admin <http:localhost:8000/admin>` to browse the tables.
-
-.. demo-end
-
-Project Information
--------------------
-
-* Documentation: https://ebird-api-data.readthedocs.io/en/latest/
-* Issues: https://github.com/StuartMacKay/ebird-api-data/issues
-* Repository: https://github.com/StuartMacKay/ebird-api-data
-
-The app is tested on Python 3.10+, and officially supports Django 4.2, 5.0 and 5.1.
-
-eBird API Data is released under the terms of the `MIT`_ license.
-
-.. _MIT: https://opensource.org/licenses/MIT

ebird_api_data-0.2.0/README.rst

@@ -1,155 +0,0 @@
-eBird API Data
-==============
-eBird API Data is a reusable Django app for loading data from eBird into a database.
-
-Overview
---------
-.. overview-start
-
-The Cornell Laboratory of Ornithology in Ithaca, New York runs the eBird database
-which collects observations of birds from all over the world. All the observations
-are published on `eBird.org`_, and they also make them available via an `API`_.
-This project contains a loader and models to take data from the API and load it into
-a database. From there you can analyse the data with python, jupyter notebooks, or
-build a web site.
-
-To get started, you will need to `sign up`_ for an eBird account, if you don't
-already have one and `register`_ to get an API key. Make sure you read and
-understand the `Terms of use`_, and remember bandwidth and servers cost money,
-so don't abuse the service. If you need large numbers of observations, then
-sign up to receive the `eBird Basic Dataset`_.
-
-.. _eBird.org: https://ebird.org
-.. _API: https://documenter.getpostman.com/view/664302/S1ENwy59
-.. _sign up: https://secure.birds.cornell.edu/identity/account/create
-.. _register: https://ebird.org/data/download
-.. _Terms of use: https://www.birds.cornell.edu/home/ebird-api-terms-of-use/
-.. _eBird Basic Dataset: https://science.ebird.org/en/use-ebird-data/download-ebird-data-products
-
-.. overview-end
-
-Install
--------
-.. install-start
-
-You can use either `pip`_ or `uv`_ to download the `package`_ from PyPI and
-install it into a virtualenv:
-
-.. code-block:: console
-
-    pip install ebird-api-data
-
-or:
-
-.. code-block:: console
-
-    uv add ebird-api-data
-
-Update ``INSTALLED_APPS`` in your Django setting:
-
-.. code-block:: python
-
-    INSTALLED_APPS = [
-        ...
-        ebird.api.data
-    ]
-
-Finally, run the migrations to create the tables:
-
-.. code-block:: python
-
-    python manage.py migrate
-
-.. _pip: https://pip.pypa.io/en/stable/
-.. _uv: https://docs.astral.sh/uv/
-.. _package: https://pypi.org/project/ebird-api-data/
-
-.. install-end
-
-Demo
-----
-
-.. demo-start
-
-If you check out the code from the repository there is a fully functioning
-Django site. It only contains the admin pages, but that is sufficient for
-you to browse the data.
-
-.. code-block:: console
-
-    git clone git@github.com:StuartMacKay/ebird-api-data.git
-    cd ebird-api-data
-
-Create the virtual environment:
-
-.. code-block:: console
-
-    uv venv
-
-Activate it:
-
-.. code-block:: console
-
-    source venv/bin/activate
-
-Install the requirements:
-
-.. code-block:: console
-
-    uv sync
-
-Run the database migrations:
-
-.. code-block:: console
-
-    python manage.py migrate
-
-Create a user:
-
-.. code-block:: console
-
-    python manage.py createsuperuser
-
-Create a copy of the .env.example file and add your API key:
-
-.. code-block:: console
-
-    cp .env.example .env
-
-.. code-block:: console
-
-    EBIRD_API_KEY=<my api key>
-
-Now, download data from the API:
-
-.. code-block:: console
-
-    python manage.py add_checklists --days 2 US-NY-109
-
-This loads all the checklists, submitted in the past two days by birders in
-Tompkins County, New York, where the Cornell Lab is based. You can use any
-location code used by eBird, whether it's for a country, state/region, or
-county. Remember, read the terms of use.
-
-Run the demo:
-
-.. code-block:: console
-
-    python manage.py runserver
-
-Now log into the `Django Admin <http:localhost:8000/admin>` to browse the tables.
-
-.. demo-end
-
-Project Information
--------------------
-
-* Documentation: https://ebird-api-data.readthedocs.io/en/latest/
-* Issues: https://github.com/StuartMacKay/ebird-api-data/issues
-* Repository: https://github.com/StuartMacKay/ebird-api-data
-
-The app is tested on Python 3.10+, and officially supports Django 4.2, 5.0 and 5.1.
-
-eBird API Data is released under the terms of the `MIT`_ license.
-
-.. _MIT: https://opensource.org/licenses/MIT

ebird_api_data-0.2.0/src/ebird/api/data/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.2.0"