Skip to content

A Python script developed to harness the power of the Outdooractive API and calculate the total length and duration of routes in your region (as per rights received via the API).

Notifications You must be signed in to change notification settings

Romania-Travel-Guide/TrailKM

Repository files navigation

trailKM.py

trailKM.py is a Python script that utilizes the Outdooractive APIs to retrieve information about trails in a specified region. It calculates the total length and duration required to cover all the trails within that region.

Prerequisites

Before running the script, ensure that you have the following:

Installation

  1. Clone the repository to your local machine using the following command:

    git clone https://github.com/Clustmart/trailKM.git
  2. Navigate to the project directory:

    cd trailKM
  3. Install the required dependencies by executing the following command:

    pip install -r requirements.txt

Usage

To use the trailKM.py script, follow these steps:

  1. Rename the file (config.example) to (config.ini) and open it in a text editor.

  2. Replace <YOUR_API_KEY> with your Outdooractive API key and <YOUR-PROJECT> with your Outdooractive project name.

  3. Save the changes.

  4. Run the script using the following command:

    python trailKM.py
  5. The script will retrieve the trail data from Outdooractive APIs and calculate the total length and duration to cover all the trails in the specified region. The results will be displayed in the console.

Contributing

Contributions to trailKM.py are welcome! If you find any issues or have ideas for improvements, please submit them via GitHub issues. Feel free to fork the repository and submit pull requests for any enhancements.

License

This project is licensed under the MIT License.

Disclaimer

Please note that the trailKM.py script is provided as-is without any warranty. It is the user's responsibility to ensure compliance with the terms and conditions of the Outdooractive APIs and any other relevant services or APIs used within the script.


About

A Python script developed to harness the power of the Outdooractive API and calculate the total length and duration of routes in your region (as per rights received via the API).

Topics

Resources

Stars

Watchers

Forks

Languages