Skip to content

Commit ee01499

Browse files
sbrunatosbrunato
authored
Merge pull request #212 from CS-SI/develop
v2.2.0
2 parents 044fd8b + 88fd434 commit ee01499

37 files changed

Lines changed: 2078 additions & 524 deletions

‎.github/pull_request_template.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
### Your checklist for this pull request
2+
Please review the [guidelines for contributing](../CONTRIBUTING.md) to this repository.
3+
4+
- [ ] Make sure you are making a pull request against the **develop branch** (left side). Also you should start *your branch* off *our develop*.
5+
- [ ] Check the commit's or even all commits' message styles matches our requested structure.
6+
- [ ] Check your code additions will fail neither code linting checks nor unit test.
7+
8+
### Description
9+
Please describe your pull request.
10+
11+
### Further comments
12+
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...
13+
14+
Thank you!

‎.github/workflows/test.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
strategy:
3030
matrix:
3131
python-version: [3.6, 3.9]
32-
os: [ubuntu-latest]
32+
os: [ubuntu-latest, windows-latest]
3333
steps:
3434
- name: Checkout the repo
3535
uses: actions/checkout@v2

‎CHANGES.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
Release history
22
---------------
33

4+
2.2.0 (2021-03-26)
5+
++++++++++++++++++
6+
7+
- New ``search_all`` and ``search_iter_page`` methods to simplify pagination handling
8+
(`GH-190 <https://github.com/CS-SI/eodag/pull/190>`_)
9+
- Docker-compose files for STAC API server with STAC-browser (`GH-183 <https://github.com/CS-SI/eodag/pull/183>`_)
10+
- Fixed USGS plugin which now uses M2M API (`GH-209 <https://github.com/CS-SI/eodag/pull/209>`_)
11+
- Windows support added in Continuous Integration (`GH-192 <https://github.com/CS-SI/eodag/pull/192>`_)
12+
- Fixes issue with automatically load configution from EODAG external plugins, fixes
13+
`GH-184 <https://github.com/CS-SI/eodag/issues/184>`_
14+
- More explicit signature for ``setup_logging``, fixes `GH-197 <https://github.com/CS-SI/eodag/issues/197>`_
15+
- Various minor fixes
16+
417
2.1.1 (2021-03-18)
518
++++++++++++++++++
619

‎CODE_OF_CONDUCT.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual identity
11+
and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the
27+
overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
admin@geostorm.eu.
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
127+
at [https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.rst‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
.. _contribute:
2+
3+
Contribute to EODAG development
4+
===============================
5+
6+
Thank you for considering contributing to eodag!
7+
8+
9+
Reporting issues
10+
----------------
11+
12+
Issue tracker: https://github.com/CS-SI/eodag/issues
13+
14+
Please check that a similar issue does not already exist and
15+
include the following information in your post:
16+
17+
- Describe what you expected to happen.
18+
- If possible, include a `minimal reproducible example`_ to help us
19+
identify the issue. This also helps check that the issue is not with
20+
your own code.
21+
- Describe what actually happened. Include the full traceback if there
22+
was an exception.
23+
- List your Python and eodag versions. If possible, check if this
24+
issue is already fixed in the latest releases or the latest code in
25+
the repository.
26+
27+
.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example
28+
29+
30+
Submitting patches
31+
------------------
32+
33+
If you intend to contribute to eodag source code:
34+
35+
.. code-block:: bash
36+
37+
git clone https://github.com/CS-SI/eodag.git
38+
cd eodag
39+
python -m pip install -r requirements-dev.txt
40+
pre-commit install
41+
42+
We use ``pre-commit`` to run a suite of linters, formatters and pre-commit hooks (``black``, ``isort``, ``flake8``) to ensure the code base is homogeneously formatted and easier to read. It's important that you install it, since we run the exact same hooks in the Continuous Integration.
43+
44+
To run the default test suite (which excludes end-to-end tests):
45+
46+
.. code-block:: bash
47+
48+
tox
49+
50+
To only run end-to-end test:
51+
52+
.. code-block:: bash
53+
54+
tox -- tests.test_end_to_end
55+
56+
To run the entire tests (units, integraton and end-to-end):
57+
58+
.. code-block:: bash
59+
60+
tox -- tests eodag
61+
62+
.. note::
63+
64+
* Running the `tox` command will also build the docs. As The documentation
65+
includes some notebooks (for the turorials), the build process will need
66+
`pandoc <http://pandoc.org>`_ to succeed. If the build process fails for
67+
you, please `install <http://pandoc.org/installing.html>`_ pandoc and try
68+
again.
69+
70+
* When contributing to tutorials, you will need to keep notebook outputs
71+
and save widget state. Otherwise outputs will not be visible in documentation.
72+
73+
* eodag is tested against python versions 3.6, 3.7, 3.8 and 3.9. Ensure you have
74+
these versions installed before you run tox. You can use
75+
`pyenv <https://github.com/pyenv/pyenv>`_ to manage many different versions
76+
of python
77+
78+
Releases are made by tagging a commit on the master branch. To make a new release,
79+
80+
* Ensure you correctly updated `README.rst` and `CHANGES.rst` (and occasionally,
81+
also `NOTICE` - in case a new dependency is added).
82+
* Check that the version string in `eodag/__meta__.py` (the variable `__version__`)
83+
is correctly updated
84+
* Push your local master branch to remote.
85+
* Tag the commit that represents the state of the release with a message. For example,
86+
for version 1.0, do this: `git tag -a v1.0 -m 'version 1.0'`
87+
* Push the tags to github: `git push --tags`.
88+
89+
The documentation is managed by a webhook, and the latest documentation on readthedocs follows
90+
the documentation present in `develop`. Therefore, there is nothing to do apart from updating
91+
the `develop` branch to publish the latest documentation.

‎README.rst‎

Lines changed: 21 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,17 @@ An eodag installation can be exposed through a STAC compliant REST api from the
150150
$ wget "http://127.0.0.1:5000/S2_MSI_L1C/country/FRA/year/2021/month/01/day/25/cloud_cover/10/items/S2A_MSIL1C_20210125T105331_N0209_R051_T31UCR_20210125T130733/download"
151151
152152
153-
You can also browse over your STAC API server using `STAC Browser <https://github.com/radiantearth/stac-browser>`_
154-
with ``CATALOG_URL=http://127.0.0.1:5000`` :
153+
You can also browse over your STAC API server using `STAC Browser <https://github.com/radiantearth/stac-browser>`_.
154+
Simply run:
155+
156+
.. code-block:: bash
157+
158+
git clone https://github.com/CS-SI/eodag.git
159+
cd eodag
160+
docker-compose up
161+
162+
163+
And browse http://127.0.0.1:5001:
155164

156165
.. image:: https://raw.githubusercontent.com/CS-SI/eodag/develop/docs/_static/stac_browser_example_600.png
157166
:target: https://raw.githubusercontent.com/CS-SI/eodag/develop/docs/_static/stac_browser_example.png
@@ -178,22 +187,23 @@ Then you can start playing with it:
178187
--start 2018-01-01 \
179188
--end 2018-01-31 \
180189
--cloudCover 20 \
181-
--productType S2_MSI_L1C
182-
--cruncher FilterLatestIntersect \
190+
--productType S2_MSI_L1C \
191+
--all \
183192
--storage my_search.geojson
184193

185-
The request above search for product types `S2_MSI_L1C` and will crunch the result using cruncher `FilterLatestIntersect`
186-
and storing the overall result to `my_search.geojson`.
194+
The request above searches for `S2_MSI_L1C` product types in a given bounding box, in January 2018. The command fetches internally all
195+
the products that match these criteria. Without `--all`, it would only fetch the products found on the first result page.
196+
It finally saves the results in a GeoJSON file.
187197

188198
You can pass arguments to a cruncher on the command line by doing this (example with using `FilterOverlap` cruncher
189199
which takes `minimum_overlap` as argument)::
190200

191-
eodag search -f my_conf.yml -b 1 43 2 44 -s 2018-01-01 -e 2018-01-31 -p S2_MSI_L1C \
201+
eodag search -f my_conf.yml -b 1 43 2 44 -s 2018-01-01 -e 2018-01-31 -p S2_MSI_L1C --all \
192202
--cruncher FilterOverlap \
193203
--cruncher-args FilterOverlap minimum_overlap 10
194204

195205
The request above means : "Give me all the products of type `S2_MSI_L1C`, use `FilterOverlap` to keep only those products
196-
that are contained in the bbox I gave you, or whom spatial extent overlaps at least 10% (`minimum_overlap`) of the surface
206+
that are contained in the bbox I gave you, or whose spatial extent overlaps at least 10% (`minimum_overlap`) of the surface
197207
of this bbox"
198208

199209
* To download the result of a previous call to `search`::
@@ -219,56 +229,11 @@ of this bbox"
219229
Contribute
220230
==========
221231

222-
If you intend to contribute to eodag source code::
223-
224-
git clone https://github.com/CS-SI/eodag.git
225-
cd eodag
226-
python -m pip install -r requirements-dev.txt
227-
pre-commit install
228-
229-
To run the default test suite (which excludes end-to-end tests)::
230-
231-
tox
232-
233-
To only run end-to-end test::
234-
235-
tox -- tests.test_end_to_end
236-
237-
To run the entire tests (units, integration and end-to-end)::
238-
239-
tox -- tests eodag
240-
241-
242-
.. note::
243-
244-
* Running the `tox` command will also build the docs. As The documentation
245-
includes some notebooks (for the turorials), the build process will need
246-
`pandoc <http://pandoc.org>`_ to succeed. If the build process fails for
247-
you, please `install <http://pandoc.org/installing.html>`_ pandoc and try
248-
again.
249-
250-
* When contributing to tutorials, you will need to keep notebook outputs
251-
and save widget state. Otherwise outputs will not be visible in documentation.
252-
253-
* eodag is tested against python versions 3.6, 3.7, 3.8 and 3.9. Ensure you have
254-
these versions installed before you run tox. You can use
255-
`pyenv <https://github.com/pyenv/pyenv>`_ to manage many different versions
256-
of python
257-
258-
Releases are made by tagging a commit on the master branch. To make a new release,
232+
For guidance on setting up a development environment and how to make a
233+
contribution to eodag, see the `contributing guidelines`_.
259234

260-
* Ensure you correctly updated `README.rst` and `CHANGES.rst` (and occasionally,
261-
also `NOTICE` - in case a new dependency is added).
262-
* Check that the version string in `eodag/__meta__.py` (the variable `__version__`)
263-
is correctly updated
264-
* Push your local master branch to remote.
265-
* Tag the commit that represents the state of the release with a message. For example,
266-
for version 1.0, do this: `git tag -a v1.0 -m 'version 1.0'`
267-
* Push the tags to github: `git push --tags`.
235+
.. _contributing guidelines: https://github.com/CS-SI/eodag/blob/develop/CONTRIBUTING.rst
268236

269-
The documentation is managed by a webhook, and the latest documentation on readthedocs follows
270-
the documentation present in `master`. Therefore, there is nothing to do apart from updating
271-
the `master` branch to publish the latest documentation.
272237

273238
LICENSE
274239
=======

0 commit comments

Comments
 (0)