enappsys 0.1.0

The EnAppSys Python client provides a light-weight client that allows for simple access to EnAppSys' API services.

EnAppSys Python Client

The Python library for the EnAppSys platform provides a light-weight Python client to interact with EnAppSys' API services. Additionally, there is an asynchronous client for non-blocking operations.

Installation

Supports Python 3.7+.

pip install enappsys[async,pandas]

The extras are optional:

• async required for using the EnAppSysAsync asynchronous client.
• pandas required for converting API responses to DataFrames, e.g. via client_response.to_df()

If you only need the synchronous client and raw responses, install without extras:

pip install enappsys

Configuring credentials

Your EnAppSys username and secret are required to make API requests. You can obtain these as follows:

1. Go to any download page on EnAppSys and click Copy API URL.

2. In the copied URL:

   • The value after user= is your username.
   • The value after pass= is your secret (a long numeric string).

The client looks for credentials in the following order:

1. Direct arguments when creating the client:

   from enappsys import EnAppSys
   
   client = EnAppSys(
       user="example_user",
       secret="123456789123456789123456789123456789"
   )
   

2. Environment variables:

   export ENAPPSYS_USER=example_user
   export ENAPPSYS_SECRET=123456789123456789123456789123456789
   

3. Credentials file at your home directory, the default location is: ~/.credentials/enappsys.json:

   {
       "user": "example_user",
       "secret": "123456789123456789123456789123456789"
   }
   

   You can also save and specify a custom path:

   client = EnAppSys(credentials_file="path/to/credentials.json")
   

Development

Install in editable mode:

python -m pip install -e .[dev]

Install the commit hooks:

pre-commit install