lifter-api-wrapper 0.4.0
A wrapper for Lifter API.
License: MIT
Requires Python: >=3.10
Keywords: weightlifting,api wrapper

# Lifter API Wrapper

[![Lint](https://github.com/WeightliftingNZ/lifter-api-wrapper/actions/workflows/lint.yml/badge.svg)](https://github.com/ChristchurchCityWeightlifting/lifter-api-wrapper/actions/workflows/lint.yml)
[![Docs](https://github.com/WeightliftingNZ/lifter-api-wrapper/actions/workflows/docs.yml/badge.svg)](https://github.com/WeightliftingNZ/lifter-api-wrapper/actions/workflows/docs.yml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Latest Version](https://img.shields.io/pypi/v/lifter-api-wrapper.svg)](https://pypi.python.org/pypi/lifter-api-wrapper/)
[![Format](https://img.shields.io/pypi/format/lifter-api-wrapper.svg)](https://pypi.python.org/pypi/lifter-api-wrapper/)
[![Python Versions](https://img.shields.io/pypi/pyversions/lifter-api-wrapper.svg)](https://pypi.python.org/pypi/lifter-api-wrapper/)
[![Implementation](https://img.shields.io/pypi/implementation/lifter-api-wrapper.svg)](https://pypi.python.org/pypi/lifter-api-wrapper/)
[![License](https://img.shields.io/pypi/status/lifter-api-wrapper.svg)](https://pypi.python.org/pypi/lifter-api-wrapper/)

This is a wrapper for making calls to [Lifter API](https://github.com/WeightliftingNZ/lifter-api).

## Getting Started

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

```sh
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.

```sh
# .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`.

You can simple create an object like so:

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

## Documentation

[Comprehensive documentation can be found here.](https://weightliftingnz.github.io/lifter-api-wrapper)

## For Local Development

For local development, you will need to clone the [API from here](https://github.com/WeightliftingNZ/lifter-api).

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 ensure the locally hosted API will be used and not the live API.

The default URL for the locally hosted API is `http://localhost:8000`. Alternatively, you can define the url to your liking: `LifterAPI(url="http://localhost:8001")`.

```bash
git clone https://github.com/WeightliftingNZ/lifter-api


cd lifter-api

make run
```

This will run a server and allow you to run tests for this wrapper.

## Contribution

[Please checkout CONTRIBUTING.md](https://github.com/WeightliftingNZ/lifter-api-wrapper/blob/main/CONTRIBUTING.md) if you interested in contributing.