Skip to content

Commit 2abde84

Browse files
luisageo6luisageo6
authored
Merge pull request #44 from earthdaily/dev
V0.0.6
2 parents c541628 + 3158d70 commit 2abde84

File tree

11 files changed

+334
-37
lines changed

11 files changed

+334
-37
lines changed

‎.github/workflows/pytest-prod.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ jobs:
1111
os:
1212
- ubuntu-latest
1313
- windows-latest
14+
- macos-latest
1415
python-version:
1516
- "3.10"
1617
- "3.11"

‎CHANGELOG.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [0.0.6] - 2024-02-23
8+
9+
### Fixed
10+
11+
- `to_wkt`for GeometryManager.
12+
13+
### Added
14+
15+
- Add docstring thanks to @piclem.
16+
- Token support thanks to @luisageo6.
17+
718
## [0.0.5] - 2024-02-19
819

920
### Fixed
@@ -176,4 +187,4 @@ really faster faster. Previous behavior is available by selecting `method="stand
176187
- First public release under the name of earthdaily.
177188
- module earthdatastore gathers all cube fonctions.
178189
- earthdatastore.Auth() allows methods for search and datacube creation.
179-
- Add if missing default scale/offset factor to collection (landsat-c2l2-sr, landsat-c2l2-st, landsat-c2l1).
190+
- Add if missing default scale/offset factor to collection (landsat-c2l2-sr, landsat-c2l2-st, landsat-c2l1).

‎README.md

+114-7
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,97 @@
1-
# Earthdaily Python Package
1+
<div id="top"></div>
2+
<!-- PROJECT SHIELDS -->
3+
<!--
4+
*** See the bottom of this document for the declaration of the reference variables
5+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
6+
-->
7+
8+
9+
<!-- PROJECT LOGO -->
10+
<br />
11+
<p>
12+
<h1 >EarthDaily Python Client</h3>
13+
14+
<p>
15+
Your gateway to the Earth Data Store STAC Catalog.
16+
<br />
17+
<a href="https://earthdailyagro.com/"><strong>Who we are</strong></a>
18+
<br />
19+
<br />
20+
<a href="https://github.com/earthdaily/earthdaily-python-client/">Project description</a>
21+
·
22+
<a href="https://github.com/earthdaily/earthdaily-python-client/issues">Report Bug</a>
23+
·
24+
<a href="https://github.com/earthdaily/earthdaily-python-client/issues">Request Feature</a>
25+
</p>
26+
</p>
27+
28+
29+
<div>
30+
231
[![PyPI version](https://badge.fury.io/py/earthdaily.png)](https://badge.fury.io/py/earthdaily)
332
[![Documentation](https://img.shields.io/badge/Documentation-html-green.svg)](https://earthdaily.github.io/earthdaily-python-client/)
433
[![pytest-main](https://github.com/earthdaily/earthdaily-python-client/actions/workflows/pytest-prod.yaml/badge.svg)](https://github.com/earthdaily/earthdaily-python-client/actions/workflows/pytest-prod.yaml)
534

6-
## Your Gateway to the Stac Catalog Earth Data Store
35+
</div>
36+
37+
38+
<!--[![Stargazers][GitStars-shield]][GitStars-url]-->
39+
<!--[![Forks][forks-shield]][forks-url]-->
40+
<!--[![Stargazers][stars-shield]][stars-url]-->
41+
42+
43+
<!-- TABLE OF CONTENTS -->
44+
<details open>
45+
<summary>Table of Contents</summary>
46+
<ol>
47+
<li>
48+
<a href="#about-the-project">About The Project</a>
49+
</li>
50+
<li>
51+
<a href="#getting-started">Getting Started</a>
52+
<ul>
53+
<li><a href="#prerequisites">Prerequisites</a></li>
54+
<li><a href="#installation">Installation</a></li>
55+
</ul>
56+
</li>
57+
<li><a href="#usage">Usage</a></li>
58+
<li><a href="#support-development">Support development</a></li>
59+
<li><a href="#license">License</a></li>
60+
<li><a href="#contact">Contact</a></li>
61+
<li><a href="#copyrights">Copyrights</a></li>
62+
</ol>
63+
</details>
64+
65+
<!-- ABOUT THE PROJECT -->
66+
## About The Project
767

868
In the realm of geospatial data analysis and Earth observation, the EarthDaily Python package emerges as a powerful toolset that seamlessly connects you to the vast and invaluable Stac catalog Earth Data Store. This package is designed with the vision of simplifying and optimizing your workflow, ensuring that you can harness the full potential of Earth observation data with ease and efficiency.
969

1070
Our package is built upon a foundation of best practices, meticulously crafted to elevate your data analysis experience. With EarthDaily, you can effortlessly navigate the complexities of datacube creation, including crucial processes like conversion to reflectance and automatic clipping to your area of interest. Additionally, we've taken care to make EarthDaily fully compatible with Dask, enabling you to scale your data preprocessing tasks with confidence and precision.
1171

12-
## Install
1372

14-
### Using pip
73+
## Features
74+
75+
See [documentation](https://earthdaily.github.io/earthdaily-python-client/) for more information
76+
77+
## Getting started
78+
79+
### Prerequisites
80+
81+
Make sure you have valid EDS credentials. If you need to get trial access, please contact us.
82+
83+
This package has been tested on Python 3.10, 3.11 and 3.12.
84+
85+
86+
### Installation
87+
88+
#### Using pip
1589

1690
`pip install earthdaily`
1791

18-
### Planned : Using conda/mamba
92+
#### Planned : Using conda/mamba
1993

20-
## Authentication
94+
### Authentication
2195
Authentication credentials are accessed from environment variables. As a convenience python-dotenv is supported.
2296
Copy the `.env.sample` file and rename to simply `.env` and update with your credentials. This file is gitignored.
2397
Then add to your script/notebook:
@@ -26,4 +100,37 @@ Then add to your script/notebook:
26100
from dotenv import load_dotenv
27101

28102
load_dotenv() # take environment variables from .env.
29-
```
103+
```
104+
105+
### Usage
106+
107+
See the documentation for more information.
108+
109+
### Support development
110+
111+
If you find this package useful, please consider supporting its development.
112+
113+
<!-- CONTRIBUTING -->
114+
## Support development
115+
116+
If this project has been useful, that it helped you or your business to save precious time, don't hesitate to give it a star.
117+
118+
<p align="right">(<a href="#top">back to top</a>)</p>
119+
120+
## License
121+
122+
Distributed under the MIT License.
123+
124+
<p align="right">(<a href="#top">back to top</a>)</p>
125+
126+
## Contact
127+
128+
For any additonal information, please [email us](mailto:[email protected]).
129+
130+
<p align="right">(<a href="#top">back to top</a>)</p>
131+
132+
## Copyrights
133+
134+
© EarthDaily | All Rights Reserved.
135+
136+
<p align="right">(<a href="#top">back to top</a>)</p>

‎docs/api.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
API Reference
22
=============
33

4-
.. toctree::
5-
:maxdepth: 3
4+
.. autosummary::
5+
:toctree: generated
66
:caption: Documentation API
7+
:template: custom-module-template.rst
8+
:recursive:
79

810
earthdaily

‎docs/conf.py

+16-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@
3434
"sphinx_automodapi.automodapi", # for a page per function
3535
"myst_parser",
3636
"rst2pdf.pdfbuilder",
37+
"sphinx_immaterial"
3738
]
39+
3840
#
3941
automodapi_toctreedirnm = "_API"
4042
numpydoc_show_class_members = False
@@ -99,7 +101,20 @@
99101
# a list of builtin themes.
100102
#
101103
# html_theme = 'alabaster'
102-
html_theme = "sphinx_rtd_theme"
104+
# html_theme = "sphinx_rtd_theme"
105+
html_theme = "sphinx_immaterial"
106+
107+
html_theme_options = {
108+
109+
"repo_url": "https://github.com/GEOSYS/earthdaily-client-python",
110+
"repo_name": "GEOSYS/earthdaily",
111+
"palette": {
112+
"scheme": "default",
113+
"palette": {
114+
"primary": "cyan",
115+
"accent": "green" }
116+
}
117+
}
103118

104119
source_suffix = [".rst", ".md"]
105120

‎docs/index.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@ earthdaily documentation
2121

2222

2323
.. toctree::
24-
:maxdepth: 3
24+
:maxdepth: 1
25+
:caption: Getting Started
2526

2627
self
28+
_auto_examples/first_steps_create_datacube
2729

2830
.. toctree::
2931
:maxdepth: 3
@@ -35,7 +37,7 @@ earthdaily documentation
3537
:maxdepth: 3
3638
:caption: Documentation API
3739

38-
earthdaily
40+
api
3941
CONTRIBUTING
4042
CHANGELOG
4143

‎earthdaily/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
from . import earthdatastore, datasets
22

3-
__version__ = "0.0.5"
3+
__version__ = "0.0.6"

0 commit comments

Comments
 (0)