ebird-pages


Nameebird-pages JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryScrapers for pages on the eBird web site
upload_time2024-10-23 16:43:47
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License
keywords ebird web scraper
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Build Status](https://travis-ci.org/ProjectBabbler/ebird-pages.svg?branch=master)](https://travis-ci.org/ProjectBabbler/ebird-pages)
[![PyPI version](https://badge.fury.io/py/ebird-pages.svg)](https://badge.fury.io/py/ebird-pages)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/ebird-pages.svg)](https://img.shields.io/pypi/pyversions/ebird-pages)

# eBird Pages

Although eBird has an API, not all the information from the database is
available. The API, for example, does not return links to any uploaded 
photos; comments on an individual observation are also missing. eBird Pages 
is a set of scrapers for extracting data from various pages on the eBird 
web site. It complements the API, giving access to all the data that eBird 
makes publicly available.

## Install

```sh
pip install ebird-pages
```

## Usage

Scraping the data from a page is as simple as a function call. For example
to get all the data from a checklist use get_checklist() and pass in the 
unique identifier generated when the checklist was submitted to the eBird
database:

```python
from ebird.pages import get_checklist

data = get_checklist('S38429565')
```
The function returns a dict with keys for the location, date, observers, etc.

You can also get the complete list of checklists from the "Recent Checklists"
page, e.g. https://ebird.org/region/US-MA/recent-checklists. From there you 
can download each checklist:

```python
import time

from ebird.pages import get_checklist, get_recent_checklists

for item in get_recent_checklists("US-MA"):
    checklist = get_checklist(item["identifier"])
    # Be nice and don't hit the servers as fast as possible
    time.sleep(10)
```


## Compatibility

ebird-pages works with all currently supported versions of Python (3.8+). 

## License

eBird Pages is available under the terms of the [MIT](https://opensource.org/licenses/MIT) license.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ebird-pages",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "eBird, web, scraper",
    "author": null,
    "author_email": "Project Babbler <projectbabbler@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/be/9c/40b26f9077378c6b118d324f9092f67857c8ad328d044f6ca4f96fc27291/ebird_pages-0.2.0.tar.gz",
    "platform": null,
    "description": "[![Build Status](https://travis-ci.org/ProjectBabbler/ebird-pages.svg?branch=master)](https://travis-ci.org/ProjectBabbler/ebird-pages)\n[![PyPI version](https://badge.fury.io/py/ebird-pages.svg)](https://badge.fury.io/py/ebird-pages)\n[![Supported Python Versions](https://img.shields.io/pypi/pyversions/ebird-pages.svg)](https://img.shields.io/pypi/pyversions/ebird-pages)\n\n# eBird Pages\n\nAlthough eBird has an API, not all the information from the database is\navailable. The API, for example, does not return links to any uploaded \nphotos; comments on an individual observation are also missing. eBird Pages \nis a set of scrapers for extracting data from various pages on the eBird \nweb site. It complements the API, giving access to all the data that eBird \nmakes publicly available.\n\n## Install\n\n```sh\npip install ebird-pages\n```\n\n## Usage\n\nScraping the data from a page is as simple as a function call. For example\nto get all the data from a checklist use get_checklist() and pass in the \nunique identifier generated when the checklist was submitted to the eBird\ndatabase:\n\n```python\nfrom ebird.pages import get_checklist\n\ndata = get_checklist('S38429565')\n```\nThe function returns a dict with keys for the location, date, observers, etc.\n\nYou can also get the complete list of checklists from the \"Recent Checklists\"\npage, e.g. https://ebird.org/region/US-MA/recent-checklists. From there you \ncan download each checklist:\n\n```python\nimport time\n\nfrom ebird.pages import get_checklist, get_recent_checklists\n\nfor item in get_recent_checklists(\"US-MA\"):\n    checklist = get_checklist(item[\"identifier\"])\n    # Be nice and don't hit the servers as fast as possible\n    time.sleep(10)\n```\n\n\n## Compatibility\n\nebird-pages works with all currently supported versions of Python (3.8+). \n\n## License\n\neBird Pages is available under the terms of the [MIT](https://opensource.org/licenses/MIT) license.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Scrapers for pages on the eBird web site",
    "version": "0.2.0",
    "project_urls": {
        "Changelog": "https://github.com/ProjectBabbler/ebird-pages/blob/master/CHANGELOG.md",
        "Issues": "https://github.com/ProjectBabbler/ebird-pages/issues",
        "Repository": "https://github.com/ProjectBabbler/ebird-pages.git"
    },
    "split_keywords": [
        "ebird",
        " web",
        " scraper"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ae58db6c721d4c2b5e7c894954608f37375235e57dc2849da59d6fdd55eb3b92",
                "md5": "44bae8046f0233517ea82832412cd6a9",
                "sha256": "e5ae11d3d91e29c0ad0906130ebe1e740d9fd20010632808ac492fae3d8532d7"
            },
            "downloads": -1,
            "filename": "ebird_pages-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "44bae8046f0233517ea82832412cd6a9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7136,
            "upload_time": "2024-10-23T16:43:46",
            "upload_time_iso_8601": "2024-10-23T16:43:46.462550Z",
            "url": "https://files.pythonhosted.org/packages/ae/58/db6c721d4c2b5e7c894954608f37375235e57dc2849da59d6fdd55eb3b92/ebird_pages-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "be9c40b26f9077378c6b118d324f9092f67857c8ad328d044f6ca4f96fc27291",
                "md5": "2b00a3f27c9fe9665431c24198d95870",
                "sha256": "f9d9e713b4ea8ef4ceb86febdc69f38f1fd9791017634feb2385334131d28c2a"
            },
            "downloads": -1,
            "filename": "ebird_pages-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2b00a3f27c9fe9665431c24198d95870",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 8425,
            "upload_time": "2024-10-23T16:43:47",
            "upload_time_iso_8601": "2024-10-23T16:43:47.951280Z",
            "url": "https://files.pythonhosted.org/packages/be/9c/40b26f9077378c6b118d324f9092f67857c8ad328d044f6ca4f96fc27291/ebird_pages-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-23 16:43:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ProjectBabbler",
    "github_project": "ebird-pages",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "ebird-pages"
}
        
Elapsed time: 1.44615s