ebird-api-data 0.1.0__tar.gz

ebird_api_data-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Stuart MacKay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ebird_api_data-0.1.0/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: ebird-api-data
+Version: 0.1.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: The MIT License (MIT)
+        
+        Copyright (c) 2025 Stuart MacKay
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Keywords: checklists,observations,species,Django,eBird,models
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: License :: OSI Approved :: MIT License
+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
+Description-Content-Type: text/x-rst
+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
+
+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.1.0/README.rst

@@ -0,0 +1,155 @@
+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.1.0/pyproject.toml

@@ -0,0 +1,158 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools >= 61.0"]
+
+[project]
+name = "ebird-api-data"
+version = "0.1.0"
+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 = { file = "LICENSE" }
+authors = [
+  {name = "Stuart MacKay", email = "smackay@flagstonesoftware.com"},
+]
+readme = "README.rst"
+requires-python = ">=3.10"
+dependencies = [
+    "beautifulsoup4>=4.13.3",
+    "django>=4.2",
+    "ebird-api-requests>=4.0.1",
+    "ebird-codes>=0.0.2",
+    "lxml>=6.0.0",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Science/Research",
+    "Framework :: Django",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.0",
+    "Framework :: Django :: 5.1",
+    "Framework :: Django :: 5.2",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+]
+
+[tool.setuptools]
+license-files = []
+
+[tool.uv]
+dev-dependencies = [
+    "bump-my-version>=0.29.0",
+    "django-environ>=0.11.2",
+    "factory-boy>=3.3.1",
+    "furo>=2024.8.6",
+    "pre-commit>=3.5.0",
+    "pygraphviz>=1.11",
+    "pytest-django>=4.9.0",
+    "pytest>=8.3.4",
+    "ruff>=0.8.4",
+    "sphinx>=7.1.2",
+    "tox-uv>=1.13.1",
+    "tox>=4.23.2",
+    "django-extensions>=3.2.3",
+    "psycopg2-binary>=2.9.10",
+    "ipython>=8.37.0",
+]
+
+[tool.bumpversion]
+current_version = "0.1.0"
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+serialize = ["{major}.{minor}.{patch}"]
+ignore_missing_version = false
+tag = true
+sign_tags = true
+tag_name = "v{new_version}"
+tag_message = "New version: {current_version} → {new_version}"
+allow_dirty = false
+commit = true
+commit_args = "--no-verify"
+message = "New version: {current_version} → {new_version}"
+pre_commit_hooks = ["uv sync --upgrade", "git add uv.lock"]
+
+[[tool.bumpversion.files]]
+filename = "src/ebird/api/data/__init__.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "docs/conf.py"
+search = 'release = "{current_version}"'
+replace = 'release = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "CHANGELOG.rst"
+search = """
+Latest
+------"""
+replace = """
+Latest
+------
+
+{new_version} ({now:%Y-%m-%d})
+------------------"""
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "CITATION.cff"
+search = "version: {current_version}"
+replace = "version: {new_version}"
+
+[[tool.bumpversion.files]]
+filename = "CITATION.cff"
+search = "^date-released: \\d{{4}}-\\d{{2}}-\\d{{2}}$"
+replace = "date-released: {now:%Y-%m-%d}"
+regex = true
+
+[tool.coverage.run]
+branch = true
+
+[tool.isort]
+multi_line_output = 3
+include_trailing_comma = true
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "demo.settings"
+pythonpath = [
+    "."
+]
+testpaths = [
+    "tests"
+]
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+requires =
+    tox>=4.2
+    tox-uv>=1.11.3
+envlist =
+    {py310,py311,py312}-django42
+    {py310,py311,py312}-django50
+    {py310,py311,py312, py313}-django51
+    {py310,py311,py312, py313}-django52
+
+[testenv]
+commands = pytest
+deps =
+    pytest
+    pytest-django
+    django42: Django>=4.2,<4.3
+    django50: Django>=5.0,<5.1
+    django51: Django>=5.1,<5.2
+    django52: Django>=5.2,<5.3
+    django-environ
+    factory-boy
+setenv =
+    DJANGO_SETTINGS_MODULE = demo.settings
+    PYTHONPATH = src
+"""

ebird_api_data-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

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

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