Skip to content

Lifter API Wrapper

Lint Docs Code style: black Latest Version Format Python Versions Implementation License

This is a wrapper for making calls to Lifter API.

Getting Started

You can install this package using pip or your favourite package manager, e.g. pipenv, poetry.

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_TOKENautomatically. Otherwise you might have to use a library like dotenv.

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"))