Skip to main content

A python wrapper to access Lifer API

Project description

Lifter API Wrapper

Documentation Status Pylint

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_TOKENautomatically. 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_wrapper 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"))

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lifter-api-wrapper-0.1.0.tar.gz (4.4 kB view hashes)

Uploaded Source

Built Distribution

lifter_api_wrapper-0.1.0-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page