earthdaily


Nameearthdaily JSON
Version 0.5.0 PyPI version JSON
download
home_pageNone
Summaryearthdaily: easy authentication, search and retrieval of Earth Data Store collections data
upload_time2025-02-11 17:12:10
maintainerNone
docs_urlNone
authorEarthDaily Agro
requires_python>=3.10
licenseMIT
keywords earth data store earthdaily earthdailyagro stac
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![PyPI version](https://badge.fury.io/py/earthdaily.svg)](https://badge.fury.io/py/earthdaily)
[![Documentation](https://img.shields.io/badge/Documentation-Online-brightgreen.svg)](https://earthdaily.github.io/earthdaily-python-client/)
[![Build Status](https://github.com/earthdaily/earthdaily-python-client/actions/workflows/pytest-prod.yaml/badge.svg)](https://github.com/earthdaily/earthdaily-python-client/actions)
![Python Versions](https://img.shields.io/badge/Python-3.10%20|%203.11%20|%203.12-blue)
[![Issues](https://img.shields.io/github/issues/earthdaily/earthdaily-python-client.svg)](https://github.com/earthdaily/earthdaily-python-client/issues)
[![License](https://img.shields.io/badge/license-MIT-blue)](#license)

# EarthDaily Python Client

Your gateway to the Earth Data Store STAC Catalog.

[EarthDaily Homepage](https://earthdaily.com) |
[Report Bug](https://github.com/earthdaily/earthdaily-python-client/issues) |
[Request Feature](https://github.com/earthdaily/earthdaily-python-client/issues)

---

The **EarthDaily Python client** simplifies access to the Earth Data Store STAC catalog and streamlines workflows for geospatial data analysis and Earth observation. It automates key preprocessing tasks, making it easier to work with Earth observation data.

## Features

- **Easy Data Access**: Connect directly to the Earth Data Store STAC catalog.
- **Automated Datacube Creation**: Includes reflectance conversion and clipping to areas of interest.
- **Scalable Processing**: Fully compatible with Dask for handling large datasets.

This package is designed to make geospatial workflows more efficient and accessible for researchers and analysts working with Earth observation data.

### Prerequisites

Make sure you have valid Earth Data Store authentication credentials. These can be retrieved from the [EarthDaily Account Management](https://console.earthdaily.com/account) page.

<p align="center">
<img src="https://github.com/earthdaily/earthdaily-python-client/raw/main/docs/assets/images/account.png" width="450">
</p>

## Installation

### From PyPI, using pip

`pip install earthdaily`

### From Repository using Conda and pip

```console
# Clone the repository and navigate inside
git clone git@github.com:earthdaily/earthdaily-python-client.git
cd earthdaily-python-client

# Create a conda environment and install dependencies
conda env create -n earthdaily -f requirements.yml
conda init
conda activate earthdaily

# Install package in editable mode
pip install -e .
```

### Authentication from Environment Variables

Authentication credentials can be automatically parsed from environment variables.
The [python-dotenv](https://github.com/theskumar/python-dotenv) package is supported for convenience.

Rename the `.env.sample` file in this repository to `.env` and enter your Earth Data Store authentication credentials. 
Note this file is gitingored and will not be committed.

In your script or notebook, add:

```python
from dotenv import load_dotenv

load_dotenv(".env")  # Load environment variables from .env file
```

## Quickstart
To help you get started quickly, we provide a `quickstart.ipynb` Jupyter notebook that demonstrates how to use the EarthDaily Python client. You only need your `.env` file with your authentication credentials to run it. 

Simply open the notebook, load your environment variables as shown above, and follow the instructions to begin accessing and analyzing Earth observation data.

## Support development

If this project has been helpful and saved you time, please consider giving it a star ⭐

## Copyrights

© EarthDaily | All Rights Reserved.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "earthdaily",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "Earth Data Store, earthdaily, earthdailyagro, stac",
    "author": "EarthDaily Agro",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/07/53/8ac600507b2fe5dc2b02742d1973d68c3edd2f527377dbb232c7eb1afd02/earthdaily-0.5.0.tar.gz",
    "platform": null,
    "description": "[![PyPI version](https://badge.fury.io/py/earthdaily.svg)](https://badge.fury.io/py/earthdaily)\n[![Documentation](https://img.shields.io/badge/Documentation-Online-brightgreen.svg)](https://earthdaily.github.io/earthdaily-python-client/)\n[![Build Status](https://github.com/earthdaily/earthdaily-python-client/actions/workflows/pytest-prod.yaml/badge.svg)](https://github.com/earthdaily/earthdaily-python-client/actions)\n![Python Versions](https://img.shields.io/badge/Python-3.10%20|%203.11%20|%203.12-blue)\n[![Issues](https://img.shields.io/github/issues/earthdaily/earthdaily-python-client.svg)](https://github.com/earthdaily/earthdaily-python-client/issues)\n[![License](https://img.shields.io/badge/license-MIT-blue)](#license)\n\n# EarthDaily Python Client\n\nYour gateway to the Earth Data Store STAC Catalog.\n\n[EarthDaily Homepage](https://earthdaily.com) |\n[Report Bug](https://github.com/earthdaily/earthdaily-python-client/issues) |\n[Request Feature](https://github.com/earthdaily/earthdaily-python-client/issues)\n\n---\n\nThe **EarthDaily Python client** simplifies access to the Earth Data Store STAC catalog and streamlines workflows for geospatial data analysis and Earth observation. It automates key preprocessing tasks, making it easier to work with Earth observation data.\n\n## Features\n\n- **Easy Data Access**: Connect directly to the Earth Data Store STAC catalog.\n- **Automated Datacube Creation**: Includes reflectance conversion and clipping to areas of interest.\n- **Scalable Processing**: Fully compatible with Dask for handling large datasets.\n\nThis package is designed to make geospatial workflows more efficient and accessible for researchers and analysts working with Earth observation data.\n\n### Prerequisites\n\nMake sure you have valid Earth Data Store authentication credentials. These can be retrieved from the [EarthDaily Account Management](https://console.earthdaily.com/account) page.\n\n<p align=\"center\">\n<img src=\"https://github.com/earthdaily/earthdaily-python-client/raw/main/docs/assets/images/account.png\" width=\"450\">\n</p>\n\n## Installation\n\n### From PyPI, using pip\n\n`pip install earthdaily`\n\n### From Repository using Conda and pip\n\n```console\n# Clone the repository and navigate inside\ngit clone git@github.com:earthdaily/earthdaily-python-client.git\ncd earthdaily-python-client\n\n# Create a conda environment and install dependencies\nconda env create -n earthdaily -f requirements.yml\nconda init\nconda activate earthdaily\n\n# Install package in editable mode\npip install -e .\n```\n\n### Authentication from Environment Variables\n\nAuthentication credentials can be automatically parsed from environment variables.\nThe [python-dotenv](https://github.com/theskumar/python-dotenv) package is supported for convenience.\n\nRename the `.env.sample` file in this repository to `.env` and enter your Earth Data Store authentication credentials. \nNote this file is gitingored and will not be committed.\n\nIn your script or notebook, add:\n\n```python\nfrom dotenv import load_dotenv\n\nload_dotenv(\".env\")  # Load environment variables from .env file\n```\n\n## Quickstart\nTo help you get started quickly, we provide a `quickstart.ipynb` Jupyter notebook that demonstrates how to use the EarthDaily Python client. You only need your `.env` file with your authentication credentials to run it. \n\nSimply open the notebook, load your environment variables as shown above, and follow the instructions to begin accessing and analyzing Earth observation data.\n\n## Support development\n\nIf this project has been helpful and saved you time, please consider giving it a star \u2b50\n\n## Copyrights\n\n\u00a9 EarthDaily | All Rights Reserved.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "earthdaily: easy authentication, search and retrieval of Earth Data Store collections data",
    "version": "0.5.0",
    "project_urls": null,
    "split_keywords": [
        "earth data store",
        " earthdaily",
        " earthdailyagro",
        " stac"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "07538ac600507b2fe5dc2b02742d1973d68c3edd2f527377dbb232c7eb1afd02",
                "md5": "ae27a46c7079e23788d43fe8424c557a",
                "sha256": "c792cf5469a28116b016aa549962fdca6032a46062bf0d57f3a900a6a811dec4"
            },
            "downloads": -1,
            "filename": "earthdaily-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ae27a46c7079e23788d43fe8424c557a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 60948,
            "upload_time": "2025-02-11T17:12:10",
            "upload_time_iso_8601": "2025-02-11T17:12:10.159451Z",
            "url": "https://files.pythonhosted.org/packages/07/53/8ac600507b2fe5dc2b02742d1973d68c3edd2f527377dbb232c7eb1afd02/earthdaily-0.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-11 17:12:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "earthdaily"
}
        
Elapsed time: 0.42368s