masstack-python-client 0.0.3

This Python API client provides access to masmovil core API domains

:warning: WORK IN PROGRESS :warning:

This Python API client provides access to masmovil core API domains.

Resources

• Feasibility

  • Coverage - find an address
    • Streets:
      • search: returns a list of street by text
      • get_building_info_by_street: returns a list of building info by street id
    • Buildings:
      • search: returns a list of buildings by text
      • multi_search: returns a list of buildings by request body
      • get: returns a building by id with a list of units
    • Units:
      • get: returns a unit by id with a list of coverages
      • get_coverage: returns coverage info for a unit id and territory_owner

• Customers

  • Signups - access to signups new clients
    • post new client
  • Users
    • returns customer tree data associated to a given document identification, email or number of the client.
    • returns user data by userId

Installation

$ pip install masstack-python-client

Configuration Environment

You need define the Masstack CLIENT_EMAIL, PRIVATE_KEY_ID TOKEN_URI, MASSTACK_DOMAIN and PRIVATE_KEY in BASE64 as environment variables to request access toekn. You need define:

MASSTACK_CLIENT_EMAIL=<YOUR CLIENT EMAIL>
MASSTACK_PRIVATE_KEY_ID=<YOUR PRIVATE KEY ID>
MASSTACK_TOKEN_URI=<MASSTACK TOKEN URI>
MASSTACK_PRIVATE_KEY_BASE64=<YOUR PRIVATE KEY in BASE64>
MASSTACK_DOMAIN=<MASSTACK DOMAIN>

If this envvars are not defined, a exception will be raised with the name of the envvar not defined.

Optional TOKEN_STORE_PATH environment variable to store token, if is not defined by defect is /tmp/masstack.token

MASSTACK_TOKEN_STORE_PATH=<YOUR PATH>

To all resources need define ORG_ID

MASSTACK_ORG_ID=<MASSTACK ORG ID>

For coverage resources need define COVERAGE_SEGMENT and COVERAGE_CHANNEL

MASSTACK_COVERAGE_SEGMENT=<SF SEGMENT>
MASSTACK_COVERAGE_CHANNEL=<SF CHANNEL>

Development

Setup environment

1. Install pyenv

curl https://pyenv.run | bash

2. Build the Python version

pyenv install 3.11.9

3. Create a virtualenv

pyenv virtualenv 3.11.9 masstack-python-client

4. Activate virtualenv

pyenv activate masstack-python-client

5. Install dependencies

pyenv exec pip install -r requirements-dev.txt

6. Install pre-commit hooks

pyenv exec pre-commit install