Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 2.58 KB

README.md

File metadata and controls

53 lines (32 loc) · 2.58 KB
Raw

Cadasta SDK

This is an SDK for interacting with the Cadasta Platform using Python. It is written to support both Python 2.7+ and Python 3.

A Warning

This codebase is very much in Alpha stage. At the moment of writing, there is little-to-no test coverage or versioning. This is still in an exporatory phase and the tooling may shift dramatically. An attempt will be made to update the example script as the codebase changes, however it can't be guaranteed. For an idea about where this codebase will be going, see the open issues.

Getting Started

The intention for this module is to make it easier to interact with the Cadasta Platform so that you build tooling quickly. It is recommended that you familiarize yourself with the Cadasta Platform (docs) and the Cadasta API (docs, interactive-docs).

More documentation about using the Cadasta SDK is to come. In the meantime, take a look at the examples to get an idea of how this could be used.

Installation

pip install git+https://github.com/cadasta/cadasta-sdk.git@master

For developing the SDK

git clone https://github.com/cadasta/cadasta-sdk.git
pip install -e cadasta-sdk/

Usage

All features are available in Python behind the cadasta namespace:

from cadasta.sdk import connection
cnxn = connection.CadastaSession()

Examples

The examples included in this repo are a collection of Python scripts intended to serve as illustrations of how developers can use the Cadasta SDK to address their needs. The goal is that common use-cases for using the Cadasta SDK to interact with the Cadasta Platform will be demonstrated within those example scripts. Additionally, they may serve as good starting-points for developers wanting to develop custom scripts for their data. It is almost certain that the scripts will have to be adjusted to fit a given dataset, as datasets are often organized differently from one another.

To run an example script, edit the variables near the top of the script (typically written in all uppercase) and (after installing the Cadasta SDK) run with Python:

python examples/a_script.py

If the script allows retrieving variables from the system environment (typically written in a pattern similar to FOO = '' or os.environ.get('foo')), the variables can be entered when calling the script:

foo=123 url="http://platform.cadasta.org" user=`whoami` dir=~/Downloads python examples/a_script.py