Skip to content

Commit bfe609f

Browse files
authored
Modify for local pytest run in CONTRIBUTING (#122)
* run pytest locally in CONTRIBUTING * fix a typo in README en passsant
1 parent 15d3c93 commit bfe609f

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,16 @@ pip install -e .
6565
If your PR targets the implementation of a new feature or the
6666
improvement of existing ones, please add at least one test per feature
6767
(in the associated
68-
[`tests/test_earthspy.py`](https://github.com/AdrienWehrle/earthspy/blob/main/LICENSE)
68+
[`tests/test_earthspy.py`](https://github.com/AdrienWehrle/earthspy/blob/main/tests/test_earthspy.py)
6969
file) and include them in your PR, using `pytest` (see existing tests
7070
for examples).
7171

72-
To run the entire test suite, run pytest in the current directory:
72+
To run the entire test suite locally, run pytest in the current
73+
directory by passing the full path to your Sentinel Hub credential
74+
file:
7375

7476
```bash
75-
pytest
77+
pytest --authfile=/path/to/auth.txt
7678
```
7779

7880

README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,6 @@
1212

1313
`earthspy` is a wrapper around methods for the download of satellite data offered in the [sentinelhub-py Python package](https://github.com/sentinel-hub/sentinelhub-py). This tool makes the monitoring and study of any place on Earth simple, ready to use and easily deployable for operational purposes and automated Near-Real Time (NRT) applications.
1414

15-
Some useful capabilities:
16-
- Data download in multiprocessing
17-
- Data download at optimized resolutions with the Direct (D) download mode
18-
- Data download at native resolutions with the Split and Merge (SM) downlodad mode
19-
- Data storage with efficient structure and file naming
20-
2115
As `earthspy` is built on top of the [Sentinel Hub services](https://www.sentinel-hub.com/), it includes e.g. the data pre-processing through [custom scripts](https://docs.sentinel-hub.com/api/latest/evalscript/) allowing the user to process and download only the products needed (such as high-level indices) therefore optimizing download time and local storage.
2216

2317
# Table of Contents

0 commit comments

Comments
 (0)