geografia-au / movemapp_client

Python client for Movemapp data and api keys on geodb/carto

MovemappClient - 🐍

A Python package for Movemapp client. Allows you to interact with the Movemapp auth and data sources.

installation

# in your requirements.txt
git+https://github.com/geografia-au/movemapp_client.git@main

Or manually:

pip install git+https://github.com/geografia-au/movemapp_client.git@main

Usage

This library is used in your code for example on a flask server to handle authentication and access to the data sources.

Pre-requisites

.env file with the following variables:

GEODB_MASTER_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
GEODB_URL=https://subdomain.geodb.host/user/username

Load the .env file and fetch the variables:

from dotenv import load_dotenv
import os
# load .env
load_dotenv()
# fetch variables from .env
GEODB_MASTER_API_KEY = os.getenv("GEODB_MASTER_API_KEY")
GEODB_URL = os.getenv("GEODB_URL")

Create a client

For each LGA you need to create a client. The client will be used to fetch, create or delete a read only token for the LGA's tables.

from movemapp_client import MovemappClient
lga_number = 24330 # Maribyrnong

client = MovemappClient(
    geodb_master_api_key=GEODB_MASTER_API_KEY,
    geodb_url=GEODB_URL,
    lga_number=lga_number
)

Get a token

Getting a token will return an existing token if it exists or create a new one if it doesn't exist.

# this will create a new token if it doesn't exist otherwise it will return the existing token based on the following name convention: mvmp_{lga_number}_ro
api_key = client.get("api_key")
print(api_key)
# {
#   'token': TEST_TOKEN,
#   'name': 'mvmp_24330_ro'
# }

Delete a token

client.delete("api_key")

Development

Install

git clone [e-mail]:geografia-au/movemapp_client.git
cd movemapp_client
pip install .

Test

Create the .env.test file with the following variables:

GEODB_MASTER_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
GEODB_URL=https://subdomain.geodb.host/user/username
TEST_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Where TEST_TOKEN is a token generated for the test lga's tables. Currently only 24330 (Maribyrnong) is supported.

python -m unittest movemapp_client.tests.test_client

Publish

pip install wheel
pip install twine
python setup.py sdist bdist_wheel
twine upload dist/*