=====================
The main purpose of this project is to provide a deployable and configurable entry point for the Geobricks REST services.
The Geobricks project takes advantage of the [blueprints](http://flask.pocoo.org/docs/0.10/blueprints/) concept to create modular components which provide services to the users. This project consist of a single [REST service](../blob/master/geobricks_rest_engine/rest/engine.py) which loads modules at the start-up of the application and provides a single entry point to the Geobricks web services.
The REST engine can be easilly configured through a simple [settings file](../blob/master/geobricks_rest_engine/config/settings.py) which contains an array of objects named `modules`. Each object describes a Geobricks service and provides the parameters to load the module. The following example describes the configuration needed to load the Geobricks MODIS plug-in:
```python
{
"description": "MODIS",
"path_to_the_blueprint": "geobricks_modis.rest.modis_rest",
"blueprint_name": "modis",
"url_prefix": "/browse/modis"
}
```
The following table provides a description of each parameter of the configuration objects.
|Name|Description|Mandatory|
|--------------|-----------|:-------:|
|description|Human readable description. This parameter is only used to make the configuration file more comprehensible and easy to mantain.|No|
|path_to_the_blueprint|The import path to the Python file which contains the blueprint.|Yes|
|blueprint_name|The name of the blueprint variable.|Yes|
|url_prefix|Every web service defined by the blueprint will be preceeded by this string. |Yes|
The `url_prefix` is very useful to group all the services provided by a module with a single entry point. As istance, every service provided by the Geobricks MODIS plug-in will be introduced by the `/browse/modis` prefix. The next table shows how the URL's are modified by the prefix.
|Original URL|Prefix|REST Engine URL|
|------------|------|---------------|
|http://example.com/|/browse/modis/|http://example.com/browse/modis/|
|http://example.com/MOD13Q1/|/browse/modis/|http://example.com/browse/modis/MOD13Q1/|
Metadata
Release files for GeobricksRESTEngine 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| GeobricksRESTEngine-0.1.4.tar.gz | 6.9 kB | Without provenance | Details for GeobricksRESTEngine-0.1.4.tar.gz |
Release files / GeobricksRESTEngine-0.1.4.tar.gz
| Download URL | GeobricksRESTEngine-0.1.4.tar.gz |
|---|---|
| Size | 6.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f25282c3bf8e123cf866c1a27d341aab1906c5789bf4b5404ef4f0980b4536fe
|
|
BLAKE2b-256 checksum How to use checksums |
14ae6689f7f0c0d4ce9abd0206ac7186bbf16c5b49940e53e36741d81ccacf2d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for GeobricksRESTEngine 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.