komoog 0.0.4

Examples

Install

pip install komoog

komoog was developed and tested for

• Python 3.6

• Python 3.7

• Python 3.8

So far, the package’s functionality was tested on macOS only.

Prerequisites

Save your komoot credentials in ~/.komoog/komoot.json as

{
    "email" : "your@email.com",
    "password" : "yourpassword",
    "clientid" : "yourclientid"
}

You can find your client id in the komoot url when you log in. Click on your username, then on “Planned Tours” or “Completed Tours”. The URL will change to something like

https://www.komoot.com/user/1851102841208/tours?type=planned

Here, 1851102841208 is your clientid.

Dependencies

komoog directly depends on the following packages which will be installed by pip during the installation process

• numpy>=1.17

• scipy>=1.5.0

• gpxpy>=1.4.2

• simplejson>=3.17.2

• simpleaudio=>=1.0.4

• matplotlib>=3.0.0

Documentation

The full documentation is available at komoog.readthedocs.io.

Changelog

Changes are logged in a separate file.

License

This project is licensed under the MIT License. Note that this excludes any images/pictures/figures shown here or in the documentation.

Contributing

If you want to contribute to this project, please make sure to read the code of conduct and the contributing guidelines. In case you’re wondering about what to contribute, we’re always collecting ideas of what we want to implement next in the outlook notes.

Dev notes

Fork this repository, clone it, and install it in dev mode.

git clone git@github.com:YOURUSERNAME/komoog.git
make

If you want to upload to PyPI, first convert the new README.md to README.rst

make readme

It will give you warnings about bad .rst-syntax. Fix those errors in README.rst. Then wrap the whole thing

make pypi

It will probably give you more warnings about .rst-syntax. Fix those until the warnings disappear. Then do

make upload