A python wrapper to access Lifter API
Project description
Lifter API Wrapper
This is a Python wrapper to access the Lifter API
Installing and Setting Up
You can install this package using pip
or your favourite package manager, e.g. pipenv
, poetry
, conda
.
pip install lifter-api-wrapper
# example using pipenv
pipenv install lifter-api-wrapper
You will also need an API key to have complete functionality. I suggest storing this as a .env
file, and remember to add this to your .gitignore
so you don't share this to a public repository by accident.
# .env
API_TOKEN=KeyGoesHere
If you use pipenv
, then the key is loaded as a environment variable API_TOKEN
automatically. Otherwise you might have to use a library like dotenv
.
Documentation
Comprehensive documentation can be found here.
You can simple create an object like so:
from lifter_api import LifterAPI
import os
lifter_api = LifterAPI(auth_token=os.getenv("API_TOKEN"))
# this will use default version, v1
# you can specify the version
lifter_api_version1 = LifterAPI(version="v1", auth_token=os.getenv("API_TOKEN"))
For Local Development
For local development, you will need to download the API from here.
You will need to set a environment variable, LOCAL_DEVELOPMENT=1
and it's a good idea to put this in the .env
file. This will means the localhost API will be hit and not the live API.
Contribution
I'm a one man show at the moment. This is still in development. So, I will be very conservative for now.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for lifter_api_wrapper-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5b151d707294b6e92eece4149881f85d6487ecef30ed83d56d1b4f76451b283 |
|
MD5 | 63c01671c192138b38796bb4c5bb4f0e |
|
BLAKE2b-256 | 98cc6cf75e6bea4c449e165be9f4956827de08af29488e4f5c91a167a51ac608 |