Skip to content

docs: updated readme #2138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sbrunato merged 3 commits into from
Apr 9, 2026
+4 −14
Merged

docs: updated readme #2138

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ae2ec6
docs: updated readme
sbrunato Apr 9, 2026
c626edb
docs: cli typo
sbrunato Apr 9, 2026
e3d0f41
docs: contribute links to rtd
sbrunato Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ EODAG is available on `PyPI <https://pypi.org/project/eodag/>`_:

.. code-block:: bash

python -m pip install eodag
pip install eodag

And with ``conda`` from the `conda-forge channel <https://anaconda.org/conda-forge/eodag>`_:

Expand All @@ -88,9 +88,8 @@ And with ``conda`` from the `conda-forge channel <https://anaconda.org/conda-for

..

[!IMPORTANT]
[!NOTE]

`Breaking change <https://eodag.readthedocs.io/en/latest/breaking_changes.html>`_ **in v3.0.0**:
Please note that EODAG
comes with a minimal set of dependencies. If you want more features, please install using one of the
`available extras <https://eodag.readthedocs.io/en/latest/getting_started_guide/install.html#optional-dependencies>`_.
Expand Down Expand Up @@ -127,15 +126,6 @@ This will search for Sentinel 2 level-1C products on the default provider and re
an estimated total number of products matching the search criteria. And then it will download these products. Please
check the `Python API User Guide <https://eodag.readthedocs.io/en/latest/api_user_guide.html>`_ for more details.

..

[!IMPORTANT]

`Breaking change <https://eodag.readthedocs.io/en/latest/breaking_changes.html>`_ **in v3.0.0**:
`search() <https://eodag.readthedocs.io/en/latest/api_reference/core.html#eodag.api.core.EODataAccessGateway.search>`_ method now returns
only a single ``SearchResult`` instead of a 2 values tuple.


Command line interface
----------------------

Expand All @@ -147,7 +137,7 @@ Start playing with the CLI:

The request above searches for ``S2_MSI_L1C`` collections in a given bounding box, in March 2021. It saves the results in a GeoJSON file (``search_results.geojson`` by default).

Results are paginated, you may want to get all pages at once with ``--all``, or search products having 20% of maximum coud cover with ``--cloudCover 20``. For more information on available options::
Results are paginated, you may want to get all pages at once with ``--all``, or search products having 20% of maximum coud cover with ``--cloud-cover 20``. For more information on available options::

eodag search --help

Expand Down Expand Up @@ -184,7 +174,7 @@ Don't hesitate and open an issue or submit a pull request, contributions are mos
For guidance on setting up a development environment and how to make a
contribution to eodag, see the `contributing guidelines`_.

.. _contributing guidelines: https://github.com/CS-SI/eodag/blob/develop/CONTRIBUTING.rst
.. _contributing guidelines: https://eodag.readthedocs.io/en/latest/contribute.html


License
Expand Down
Loading