A package for easy access to Geo Engine instances
Project description
Geo Engine Python Package
This package allows easy access to Geo Engine functionality from Python environments.
Test
Create a virtual environment
Create a virtual environment (e.g., python3 -m venv env
).
# create new venv
python3 -m venv env
# activate new venv
source env/bin/activate
Re-create virtual environment
# go out of old venv
deactivate
# delete oldv env
rm -r env
# create new venv
python3 -m venv env
# activate new venv
source env/bin/activate
Install dependencies
Then, install the dependencies with:
python3 -m pip install -e .
python3 -m pip install -e .[test]
Run tests
Run tests with:
pytest
Dependencies
Since we use cartopy
, you need to have the following system dependencies installed.
- GEOS
- PROJ
For Ubuntu, you can use this command:
sudo apt-get install libgeos-dev libproj-dev
Build
You can build the package with:
python3 -m pip install -e .[dev]
python3 -m build
Formatting
This package is formatted according to pycodestyle
.
You can check it by calling:
python3 -m pycodestyle
Our tip is to install autopep8
and use it to format the code.
Lints
Our CI automatically checks for lint errors.
We use pylint
to check the code.
You can check it by calling:
python3 -m pylint geoengine
python3 -m pylint tests
Our tip is to activate linting with pylint
in your IDE.
Type Checking
Our CI automatically checks for typing errors.
We use mypy
to check the code.
You can check it by calling:
python3 -m mypy geoengine
python3 -m mypy tests
Using the config file mypy.ini
, you can suppress missing stub errors for external libraries.
You can ignore a library by adding two lines to the config file. For example, suppressing matplotlib would look like this:
[mypy-matplotlib.*]
ignore_missing_imports = True
If there are typing-stubs packages you can install using pip
, you can use these packages instead of ignoring the reported errors.
To find out, which packages could be installed you can use the following command:
python3 -m mypy geoengine --install-types
python3 -m mypy tests --install-types
Keep in mind, that you need to add the missing stubs by extending the dependencies in setup.cfg
or ignoring them with mypy.ini
.
Our tip is to activate type checking with mypy
in your IDE.
Documentation
Generate documentation HTML with:
pdoc3 --html --output-dir docs geoengine
Examples
There are several examples in the examples
folder.
It is necessary to install the dependencies with:
python3 -m pip install -e .[examples]
Distribute to PyPI
Test-PyPI
python3 -m build
python3 -m twine upload --repository testpypi dist/*
PyPI
python3 -m build
python3 -m twine upload --repository pypi dist/*
Try it out
Start a python terminal and try it out:
import geoengine as ge
from datetime import datetime
ge.initialize("https://nightly.peter.geoengine.io/api")
time = datetime.strptime('2014-04-01T12:00:00.000Z', "%Y-%m-%dT%H:%M:%S.%f%z")
workflow = ge.workflow_by_id('4cdf1ffe-cb67-5de2-a1f3-3357ae0112bd')
print(workflow.get_result_descriptor())
workflow.get_dataframe(ge.Bbox([-60.0, 5.0, 61.0, 6.0], [time, time]))
Authentication
If the Geo Engine server requires authentication, you can set your credentials in the following ways:
- in the initialize method:
ge.initialize("https://nightly.peter.geoengine.io/api", ("email", "password"))
- as environment variables
export GEOENGINE_EMAIL="email"
andexport GEOENGINE_PASSWORD="password"
- in a .env file in the current working directory with the content:
GEOENGINE_EMAIL="email"
GEOENGINE_PASSWORD="password"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for geoengine-0.8.0b3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fc5e3167fc0d65ffed9abb3929280221edfe09be98e5421e5c6722143861a48 |
|
MD5 | b25327d157511b4c243b7775e60a8e45 |
|
BLAKE2b-256 | ebf3ba76f63f3755c8596d5f6f2065c47348d793b111c65cbf453eb155d01cdb |