Skip to main content

Basic library for authenticating and querying Garmin Connect

Project description

Garpyclient: Basic library for authenticating and querying Garmin Connect

PyPI-Status Tests Coveralls

garpyclient is a simple library to communicate with Garmin Connect. It was extracted from garpy and the idea is for this to become the core client library of it in a next iteration. Ideally, garpyclient is intended to be used by other python libraries that want to download their data from Garmin Connect. It is kept simple on purpose so that end users can build upon it with their own workflows. As an example, the following code will fetch the latest activity from your Garmin profile:

from garpyclient import GarminClient

with GarminClient(username="user", password="pass") as client:
    activities = client.list_activities()
    response = client.get_activity(activities[0]["activityId"], fmt="original")

The file content will be found in response.content. The format of the file will depend on the parameter fmt to which you can pass the following values:

  • For an overview of the activities: summary or details
  • For data points of the activity: gpx, tcx, original (usually fit format) and kml.

Installation

garpyclient requires Python 3.7 or higher on your system. Install with pip as follows:

    pip install -U garpyclient

If you are new to Python, I recommend you install Miniconda. To my knowledge, it is the simplest way of installing a robust and lightweight Python environment.

Acknowledgements

The original library (garpy) is based on garminexport. I borrowed the GarminClient, refactored it to my taste and created a package from it.

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

garpyclient-0.1.1.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

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

garpyclient-0.1.1-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: garpyclient-0.1.1.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.7 Linux/5.15.0-56-generic

File hashes

Hashes for garpyclient-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0251e47d217736b087ea31221f8d45f0e96b3757143bd784d551d44009598f3b
MD5 3117d6563d1433a517e5ced3c434d239
BLAKE2b-256 8f3f3b280fe134fecd8534860bb4258018cf15da8850ee1af8fe3d369f4cb17e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: garpyclient-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.7 Linux/5.15.0-56-generic

File hashes

Hashes for garpyclient-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2ae2bfbbc45360081ff183e990a47c70b5c04aac14624c11ed9e5e543bf699cf
MD5 a53545ad5335ddcdaeeda72c6e32859f
BLAKE2b-256 c0b030d701c9783b19442e081341d0275cc9e7d3530636495f5c4ab2efa89a5f

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