| Name | ebird-checklists JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | None |
| Summary | eBird Checklists is a reusable Django app for loading data from eBird into a database. |
| upload_time | 2025-02-01 18:22:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | The MIT License (MIT) Copyright (c) 2024 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
django
ebird
models
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
eBird Checklists
================
eBird Checklists is a reusable Django app for loading data from eBird into a database.
Overview
--------
.. overview-start
Observations submitted to eBird are available from three sources:
1. The `eBird Basic Dataset`_
2. Records from `Download My Data`_ in your eBird account
3. Records downloaded from the `eBird API 2.0`_
This project contains loaders and models to take data from each of these
sources and load it into a database. The models also have custom QuerySets
which implement the most common queries, providing an easy to use API for
accessing the data.
.. _eBird Basic Dataset: https://support.ebird.org/en/support/solutions/articles/48000838205-download-ebird-data#anchorEBD
.. _Download My Data: https://ebird.org/downloadMyData
.. _eBird API 2.0: https://documenter.getpostman.com/view/664302/S1ENwy59
.. 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-checklists
or:
.. code-block:: console
uv add ebird-checklists
Update ``INSTALLED_APPS`` in your Django setting:
.. code-block:: python
INSTALLED_APPS = [
...
ebird.checklists
]
Finally, run the migrations to create the tables:
.. code-block:: python
python manage.py migrate
Everything is now ready to load data from one of the sources above. The
project documentation has detailed instructions in the ``Loading Data``
section. Please see 'Project Information' below.
.. _pip: https://pip.pypa.io/en/stable/
.. _uv: https://docs.astral.sh/uv/
.. _package: https://pypi.org/project/ebird-checklists/
.. install-end
Demo
----
.. demo-start
If you check out the code from the repository there is a fully functioning
Django site, and a sample data file for the eBird Basic Dataset, that you
can use to see the app in action.
.. code-block:: console
git clone git@github.com:StuartMacKay/ebird-checklists.git
cd ebird-checklists
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
Load the sample data from the eBird Basic Dataset:
.. code-block:: console
python manage.py load_csv data/downloads/ebird_basic_dataset_sample.csv
Create a user:
.. code-block:: console
python manage.py createsuperuser
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-checklists.readthedocs.io/en/latest/
* Issues: https://github.com/StuartMacKay/ebird-checklists/issues
* Repository: https://github.com/StuartMacKay/ebird-checklists
The app is tested on Python 3.8+, and officially supports Django 4.2, 5.0 and 5.1.
eBird Checklists is released under the terms of the `MIT`_ license.
.. _MIT: https://opensource.org/licenses/MIT
Raw data
{
"_id": null,
"home_page": null,
"name": "ebird-checklists",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "checklists, Django, eBird, models",
"author": null,
"author_email": "Stuart MacKay <smackay@flagstonesoftware.com>",
"download_url": "https://files.pythonhosted.org/packages/b4/d2/9701a03fa60588f3b16206e8547ed20b785c706cdee51ae54c93a35cef3d/ebird_checklists-0.8.0.tar.gz",
"platform": null,
"description": "eBird Checklists\n================\neBird Checklists is a reusable Django app for loading data from eBird into a database.\n\nOverview\n--------\n.. overview-start\n\nObservations submitted to eBird are available from three sources:\n\n1. The `eBird Basic Dataset`_\n2. Records from `Download My Data`_ in your eBird account\n3. Records downloaded from the `eBird API 2.0`_\n\nThis project contains loaders and models to take data from each of these\nsources and load it into a database. The models also have custom QuerySets\nwhich implement the most common queries, providing an easy to use API for\naccessing the data.\n\n.. _eBird Basic Dataset: https://support.ebird.org/en/support/solutions/articles/48000838205-download-ebird-data#anchorEBD\n.. _Download My Data: https://ebird.org/downloadMyData\n.. _eBird API 2.0: https://documenter.getpostman.com/view/664302/S1ENwy59\n\n.. overview-end\n\nInstall\n-------\n.. install-start\n\nYou can use either `pip`_ or `uv`_ to download the `package`_ from PyPI and\ninstall it into a virtualenv:\n\n.. code-block:: console\n\n pip install ebird-checklists\n\nor:\n\n.. code-block:: console\n\n uv add ebird-checklists\n\nUpdate ``INSTALLED_APPS`` in your Django setting:\n\n.. code-block:: python\n\n INSTALLED_APPS = [\n ...\n ebird.checklists\n ]\n\nFinally, run the migrations to create the tables:\n\n.. code-block:: python\n\n python manage.py migrate\n\nEverything is now ready to load data from one of the sources above. The\nproject documentation has detailed instructions in the ``Loading Data``\nsection. Please see 'Project Information' below.\n\n.. _pip: https://pip.pypa.io/en/stable/\n.. _uv: https://docs.astral.sh/uv/\n.. _package: https://pypi.org/project/ebird-checklists/\n\n.. install-end\n\nDemo\n----\n\n.. demo-start\n\nIf you check out the code from the repository there is a fully functioning\nDjango site, and a sample data file for the eBird Basic Dataset, that you\ncan use to see the app in action.\n\n.. code-block:: console\n\n git clone git@github.com:StuartMacKay/ebird-checklists.git\n cd ebird-checklists\n\nCreate the virtual environment:\n\n.. code-block:: console\n\n uv venv\n\nActivate it:\n\n.. code-block:: console\n\n source venv/bin/activate\n\nInstall the requirements:\n\n.. code-block:: console\n\n uv sync\n\nRun the database migrations:\n\n.. code-block:: console\n\n python manage.py migrate\n\nLoad the sample data from the eBird Basic Dataset:\n\n.. code-block:: console\n\n python manage.py load_csv data/downloads/ebird_basic_dataset_sample.csv\n\nCreate a user:\n\n.. code-block:: console\n\n python manage.py createsuperuser\n\nRun the demo:\n\n.. code-block:: console\n\n python manage.py runserver\n\nNow log into the `Django Admin <http:localhost:8000/admin>` to browse the tables.\n\n.. demo-end\n\nProject Information\n-------------------\n\n* Documentation: https://ebird-checklists.readthedocs.io/en/latest/\n* Issues: https://github.com/StuartMacKay/ebird-checklists/issues\n* Repository: https://github.com/StuartMacKay/ebird-checklists\n\nThe app is tested on Python 3.8+, and officially supports Django 4.2, 5.0 and 5.1.\n\neBird Checklists is released under the terms of the `MIT`_ license.\n\n.. _MIT: https://opensource.org/licenses/MIT\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2024 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. ",
"summary": "eBird Checklists is a reusable Django app for loading data from eBird into a database.",
"version": "0.8.0",
"project_urls": null,
"split_keywords": [
"checklists",
" django",
" ebird",
" models"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ad7173ab93b5d312e48f630c6446ac09a03d11dfc18f01e6439d41c31b46eadc",
"md5": "5d87f02c658bef8d2badaf682a26e370",
"sha256": "ea236b7c7393d7359194912ac92a78cf08863924cb0429cf01947c060d07fef8"
},
"downloads": -1,
"filename": "ebird_checklists-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d87f02c658bef8d2badaf682a26e370",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 30617,
"upload_time": "2025-02-01T18:22:25",
"upload_time_iso_8601": "2025-02-01T18:22:25.093870Z",
"url": "https://files.pythonhosted.org/packages/ad/71/73ab93b5d312e48f630c6446ac09a03d11dfc18f01e6439d41c31b46eadc/ebird_checklists-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b4d29701a03fa60588f3b16206e8547ed20b785c706cdee51ae54c93a35cef3d",
"md5": "6f32440ccb40bd617bb6effcaef2633c",
"sha256": "099a19ba2d1356999a3c81c50e3c40c3e120504f3c7a6f5134331a5587b29ac6"
},
"downloads": -1,
"filename": "ebird_checklists-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "6f32440ccb40bd617bb6effcaef2633c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 24964,
"upload_time": "2025-02-01T18:22:27",
"upload_time_iso_8601": "2025-02-01T18:22:27.702102Z",
"url": "https://files.pythonhosted.org/packages/b4/d2/9701a03fa60588f3b16206e8547ed20b785c706cdee51ae54c93a35cef3d/ebird_checklists-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-01 18:22:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ebird-checklists"
}
