Package Health Score

50 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Sustainable

Popularity

Small

GitHub Stars: 976
Forks: 243
Contributors: 30

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package frx08-sentinelsat, we found that it has been starred 976 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Jun 26, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 2
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

We found a way for you to contribute to the project! Looks like frx08-sentinelsat is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 3
Open PR: 1
Last Release: 1 year ago
Last Commit: 9 months ago

Further analysis of the maintenance status of frx08-sentinelsat based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for frx08-sentinelsat is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the frx08-sentinelsat repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like frx08-sentinelsat is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==3.10.*, ==3.11.*, ==3.6.*, ==3.7.*, ==3.8.*, ==3.9.*

Age: 1 year
Latest Release: 1 year ago
Dependencies: 6 Direct / 13 Total
Versions: 2
Maintainers: 1
Wheels: OS Independent

Readme

sentinelsat

Sentinelsat makes searching, downloading and retrieving the metadata of Sentinel satellite images from the Copernicus Open Access Hub easy.

It offers an easy-to-use command line interface

sentinelsat -u  -p  --location Berlin --sentinel 2 --cloud 30 --start NOW-1MONTH

and a powerful Python API.

from sentinelsat import SentinelAPI, read_geojson, geojson_to_wkt

api = SentinelAPI('user', 'password')
footprint = geojson_to_wkt(read_geojson('search_polygon.geojson'))
products = api.query(footprint,
                     producttype='SLC',
                     orbitdirection='ASCENDING',
                     limit=10)
api.download_all(products)

Documentation is published at .

Installation

Install sentinelsat through pip:

pip install sentinelsat

Usage

Sentinelsat provides a Python API and a command line interface to search, download and retrieve the metadata for Sentinel products.

Python Library

from sentinelsat import SentinelAPI, read_geojson, geojson_to_wkt
from datetime import date

# connect to the API
api = SentinelAPI('user', 'password', 'https://apihub.copernicus.eu/apihub')

# download single scene by known product id
api.download()

# search by polygon, time, and Hub query keywords
footprint = geojson_to_wkt(read_geojson('map.geojson'))
products = api.query(footprint,
                     date = ('20151219', date(2015, 12, 29)),
                     platformname = 'Sentinel-2',
                     cloudcoverpercentage = (0, 30))

# download all results from the search
api.download_all(products)

# GeoJSON FeatureCollection containing footprints and metadata of the scenes
api.to_geojson(products)

# GeoPandas GeoDataFrame with the metadata of the scenes and the footprints as geometries
api.to_geodataframe(products)

# Get basic information about the product: its title, file size, MD5 sum, date, footprint and
# its download url
api.get_product_odata()

# Get the product's full metadata available on the server
api.get_product_odata(, full=True)

Valid search query keywords can be found at the Copernicus Open Access Hub documentation.

Command Line Interface

A basic search query consists of a search area geometry as well as the username and password to access the Copernicus Open Access Hub.

sentinelsat -u  -p  -g

Search areas are provided as GeoJSON files, which can be created with QGIS or geojson.io. If you do not specify a start and end date only products published in the last 24 hours will be queried.

Example

Search and download all Sentinel-1 scenes of type SLC, in descending orbit, for the year 2015.

sentinelsat -u  -p  -g  -s 20150101 -e 20151231 -d \
--producttype SLC -q "orbitdirection=Descending" \
--url "https://apihub.copernicus.eu/apihub"

Username, password and DHuS URL can also be set via environment variables for convenience.

# same result as query above
export DHUS_USER=""
export DHUS_PASSWORD=""
export DHUS_URL="https://apihub.copernicus.eu/apihub"

sentinelsat -g  -s 20150101 -e 20151231 -d \
--producttype SLC -q "orbitdirection=Descending"

Options

-u	--user	TEXT	Username [required] (or environment variable DHUS_USER)
-p	--password	TEXT	Password [required] (or environment variable DHUS_PASSWORD)
	--url	TEXT	Define another API URL. Default URL is 'https://apihub.copernicus.eu/apihub/'.
-s	--start	TEXT	Start date of the query in the format YYYYMMDD or an expression like NOW-1DAY.
-e	--end	TEXT	End date of the query.
-g	--geometry	PATH	Search area geometry as GeoJSON file.
	--uuid	TEXT	Select a specific product UUID. Can be set more than once.
	--name	TEXT	Select specific product(s) by filename. Supports wildcards. Can be set more than once.
	--sentinel	INT	Limit search to a Sentinel satellite (constellation).
	--instrument	TEXT	Limit search to a specific instrument on a Sentinel satellite.
	--producttype	TEXT	Limit search to a Sentinel product type.
-c	--cloud	INT	Maximum cloud cover in percent. (requires --sentinel to be 2 or 3)
-o	--order-by	TEXT	Comma-separated list of keywords to order the result by. Prefix '-' for descending order.
-l	--limit	INT	Maximum number of results to return. Defaults to no limit.
-d	--download		Download all results of the query.
	--fail-fast		Skip all other other downloads if one fails.
	--path	PATH	Set the path where the files will be saved.
-q	--query	TEXT	Extra search keywords you want to use in the query. Example: '-q producttype=GRD -q polarisationmode=HH'. Repeated keywords are interpreted as an "or" expression.
-f	--footprints	FILENAME	Create a GeoJSON file at the provided path with footprints and metadata of the returned products. Set to '-' for stdout.
	--include-pattern	TEXT	Glob pattern to filter files (within each product) to be downloaded.
	--exclude-pattern	TEXT	Glob pattern to filter files (within each product) to be excluded from the downloaded.
	--timeout	FLOAT	How long to wait for a DataHub response (in seconds, default 60 sec).
	--gnss		Query orbit products form the GNSS end-point ("https://scihub.copernicus.eu/gnss").
	--fmt	TEXT	Specify a custom format to print results. The format string shall be compatible with the Python "Format Specification Mini-Language".
	--info		Display DHuS server information.
	--version		Show version number and exit.
	--debug		Print debug log messages.
-h	--help		Show help message and exit.

Tests

To run the tests on sentinelsat:

git clone https://github.com/sentinelsat/sentinelsat.git
cd sentinelsat
pip install -e .[dev]
pytest -v

By default, prerecorded responses to Copernicus Open Access Hub queries are used to not be affected by its downtime. To allow the tests to run actual queries against the Copernicus Open Access Hub set the environment variables

export DHUS_USER=
export DHUS_PASSWORD=

and add --disable-vcr to pytest arguments. To update the recordings use --vcr-record with once, new_episodes or all. See vcrpy docs for details.

Documentation

To build the documentation:

git clone https://github.com/sentinelsat/sentinelsat.git
cd sentinelsat
pip install -e .[dev]
cd docs
make html

The full documentation is also published at .

Changelog

See CHANGELOG. You can also use GitHub's compare view to see the changes in the main branch since last release.

Contributors

We invite anyone to participate by contributing code, reporting bugs, fixing bugs, writing documentation and tutorials and discussing the future of this project. Please check CONTRIBUTE.rst.

For a list of maintainers and contributors please see AUTHORS.rst and the contributor graph.

License

GPLv3+

frx08-sentinelsat dependencies

click geojson geomet html2text requests tqdm

FAQs

What is frx08-sentinelsat?

Utility to search and download Copernicus Sentinel satellite images. Visit Snyk Advisor to see a full health score report for frx08-sentinelsat, including popularity, security, maintenance & community analysis.

Is frx08-sentinelsat popular?

The python package frx08-sentinelsat receives a total of 32 weekly downloads. As such, frx08-sentinelsat popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is frx08-sentinelsat well maintained?

We found indications that frx08-sentinelsat is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is frx08-sentinelsat safe to use?

While scanning the latest version of frx08-sentinelsat, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 11 November-2024, at 23:13 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

sentinelsat

Installation

Usage

Python Library

Command Line Interface

Example

Options

Tests

Documentation

Changelog

Contributors

License

frx08-sentinelsat dependencies

FAQs

What is frx08-sentinelsat?

Is frx08-sentinelsat popular?

Is frx08-sentinelsat well maintained?

Is frx08-sentinelsat safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues