-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
Showing
4 changed files
with
97 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
|
||
=============== | ||
Configuration | ||
=============== | ||
|
||
.. warning:: | ||
Configuration files are an experimental feature | ||
and some details are subject to change. | ||
|
||
.. versionadded:: 0.10.0 | ||
|
||
|
||
.. _configuration_files: | ||
|
||
Configuration files | ||
==================== | ||
|
||
Some functionality of the openEO Python client library can customized | ||
through a configuration file. | ||
|
||
Format | ||
------- | ||
|
||
At the moment, only INI-style configs are supported. | ||
This is a simple configuration format, easy to maintain | ||
and it is supported out of the box in Python (without additional libraries). | ||
|
||
Example (note the use of sections and support for comments):: | ||
|
||
[General] | ||
# Print loaded configuration file and default back-end URLs in interactive mode | ||
verbose = auto | ||
|
||
[Connection] | ||
default_backend = openeo.cloud | ||
|
||
|
||
.. _configuration_file_locations: | ||
|
||
Location | ||
--------- | ||
|
||
The following configuration locations are probed (in this order) for an existing configuration file. The first successful hit will be loaded: | ||
|
||
- the path in environment variable ``OPENEO_CLIENT_CONFIG`` if it is set (filename must end with extension ``.ini``) | ||
- the file ``openeo-client-config.ini`` in the current working directory | ||
- the file ``${OPENEO_CONFIG_HOME}/openeo-client-config.ini`` if the environment variable ``OPENEO_CONFIG_HOME`` is set | ||
- the file ``${XDG_CONFIG_HOME}/openeo-python-client/openeo-client-config.ini`` if environment variable ``XDG_CONFIG_HOME`` is set | ||
- the file ``.openeo-client-config.ini`` in the home folder of the user | ||
|
||
|
||
Configuration options | ||
---------------------- | ||
|
||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters