Kompy, a Wrapper for Komoot APIs

Published at

2 days ago

Main Article

https://github.com/Tsadoq/kompy

Kompy

Overview

Kompy is a wrapper for Komoot APIs that allows you to download and upload your activities from Komoot.

A documentation can be found here.

Features

Download Activities from Komoot: Download your activities from Komoot to GPX, FIT or Custom Object format.
Upload Activities to Komoot: Upload your activities to Komoot from GPX, FIT files.
Download Tours from Komoot: Download your tours from Komoot
Change Activities on Komoot: Change activity type or name of your existing activity on Komoot
Delete Activities on Komoot: Delete your existing activity on Komoot

Installation

To get started with the Kompy, follow these steps:

Ensure you have Python installed on your system. This app is compatible with Python 3.11 and above.
pip the package:
```
pip install kompy
```
Import the package to your project:
```
import kompy as kp
```

Usage

For a more detailed usage example, please check this notebook.

The most basic usage is:

Create a connector:

from kompy import KomootConnector
connector = KomootConnector(password=..., email=...)

Fetch your activities:

tours_list = connector.get_tours(user_identifier=None)

Run the tests

To run the tests (locally), run:

  pytest .

  python -m unittest

Contributing

Contributions to Kompy are welcome! If you have a suggestion that would make this app better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

gittech. site