Skip to main content

An Unofficial Python wrapper for The Gym Group's API.

Project description

thegymgroup-python

Unofficial Python SDK for The Gym Group mobile API.

This project is not affiliated with The Gym Group.

Requirements

  • Python >= 3.13
  • requests

Install

From PyPI:

pip install thegymgroup-python

Login

from thegymgroup import Client

client = Client.login("you@example.com", "1234")

Example: Gym occupancy (with percentage, capacity, and historical loop)

from thegymgroup import Client, Locations

client = Client.login("you@example.com", "1234")
occupancy = client.get_gym_occupancy(Locations.SHEFFIELD_KELHAM_ISLAND)

print(f"Gym: {occupancy.gym_location_name}")
print(f"Status: {occupancy.status}")
print(f"Current: {occupancy.current_percentage}% ({occupancy.current_capacity} people)")

for point in occupancy.historical:
    print(f"{point.hour}: {point.percentage}%")

Example: Get latest check-in

from thegymgroup import Client

client = Client.login("you@example.com", "1234")
latest = client.get_latest_check_in()
print(latest)

Example: Get hours in gym over a date range

from datetime import date

from thegymgroup import Client

client = Client.login("you@example.com", "1234")
hours = client.get_hours_in_gym(
    start=date(2026, 3, 1),
    end=date(2026, 3, 11),
)
print(f"Hours in gym: {hours}")

Example: Get classes for a location and time window

from datetime import datetime

from thegymgroup import Client, Locations

client = Client.login("you@example.com", "1234")
classes = client.get_classes(
    location=Locations.SHEFFIELD_KELHAM_ISLAND,
    start=datetime(2026, 3, 11, 0, 0),
    end=datetime(2026, 3, 11, 23, 59),
)

print(f"Found {len(classes.get('classes', []))} classes")

Notes

  • This SDK targets mobile API endpoints and may break if upstream APIs change.
  • Use at your own risk.

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

thegymgroup_python-0.1.1.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

thegymgroup_python-0.1.1-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file thegymgroup_python-0.1.1.tar.gz.

File metadata

  • Download URL: thegymgroup_python-0.1.1.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Manjaro Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for thegymgroup_python-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d6090011bba51a8098b61bcd52e4febb51249c35a00de238e857623b2f34c95c
MD5 c3f039e1ac5f89f9db9091f1a61f34e0
BLAKE2b-256 2c533b9dea8d7d61cf35717db9fe529ac60c3b6f21a091d708a8cd16d54325be

See more details on using hashes here.

File details

Details for the file thegymgroup_python-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: thegymgroup_python-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Manjaro Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for thegymgroup_python-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0614a518cf5eae49a8b7d9f799a572dcd8190f5900a956944d8e6a5777678ab7
MD5 dc2e1fa7f461283760ff5c9c177f46fb
BLAKE2b-256 282b4ece9a2ded920dafcb23d23a57557ae61c61660683ef4219152d468680e2

See more details on using hashes here.

Supported by

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