The purpose of this repository is to both demonstrate the basic functioning of the MapLarge Python REST client, as well as provide general utilities that both show how the REST client can be used and provide basic functionality for setup and administration of MapLarge Server clusters.
The maplargerest package is available from PyPi, and can be included in any deployment using standard
commands, such as pip.
$ pip install maplargerestThe examples are put together as Python mini-projects, intended to be self-contained. Each of these subprojects are grouped into two general categories:
| Category | Directory | Purpose |
|---|---|---|
| Core Functionality | core/ |
These projects demonstrate basic functions, such as auth, listing tables, running queries, or getting statuses. Individually they provide little have for day to day administration. |
| Setup and Admin | scenarios/ |
These sub projects are built as example utilities that can perform typical operations related to setting up or adjusting one or more MapLarge Server clusters |
Each core and scenario subproject includes the following:
- A
README.mdexplaining the feature of the demonstration or the use case for the utility script- If required, preliminary info and steps to run the demo should be included in the README file
- Additional markdown instructions may also be included with respect to setup and execution
- One or more Python scripts used to demonstrate or carry out the operation
- Example configuration files, if required, for setting up data sources, auth, and automated operations