Metadata-Version: 2.4
Name: puregym_attendance
Version: 2.0
Summary: A python client to query the PureGym mobile API for live gym attendance
License-File: LICENSE
Author: Tom Hollingsworth
Author-email: tom@holli.dev
Requires-Python: >=3.8
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: requests (>=2.32.4)
Requires-Dist: textdistance (>=4.6.3)
Project-URL: Repository, https://github.com/2t6h/puregym-attendance
Description-Content-Type: text/markdown

# puregym-attendance

puregym-attendance is a Python client to query the PureGym Mobile API for live gym attendance statistics.

## Installation

```python
pip install puregym_attendance
```

## Usage

```python
from puregym_attendance import PuregymAPIClient

client = PuregymAPIClient(
    email="example@email.com",
    pin=123456
)
print(client.get_gym_attendance())
```

```python
python3 -m puregym_attendance [email] [pin]

Optional Arguments
--gym [gym name OR gym ID] (defaults to puregym home gym)
```

## Development Dependencies

[Poetry](https://python-poetry.org/docs/basic-usage/) - `pip install poetry`

  - `poetry install` will install the necessary packages into a venv from there.

  - `poetry shell` will enter into that venv for development.
  
  - `poetry add [package]` will add a package to the venv and associated lockfile.

  - `poetry run python puregym.py [email] [pin]` (per the Usage section) will run the script inside the venv without leaving your local environment.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)

