https://github.com/friedrichfroebel/gc2oc
Retrieve GC -> OC code mappings
https://github.com/friedrichfroebel/gc2oc
geocaching okapi opencaching
Last synced: 3 months ago
JSON representation
Retrieve GC -> OC code mappings
- Host: GitHub
- URL: https://github.com/friedrichfroebel/gc2oc
- Owner: FriedrichFroebel
- License: mit
- Created: 2020-06-03T17:27:10.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-20T12:41:53.000Z (almost 5 years ago)
- Last Synced: 2025-01-07T12:39:37.670Z (4 months ago)
- Topics: geocaching, okapi, opencaching
- Language: Python
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Mapper for Geocaching.com and Opencaching.de
This is a collection of tools to retrieve the GC -> OC code mappings used on the Opencaching.de site.
## Usage
### Requirements
Make sure you have
* Python 3 (at least version 3.6)
* [requests](https://github.com/requests/requests)
* [GitPython](https://github.com/gitpython-developers/GitPython) (only when pushing changes)
installed on your device.
### Preparations
1. Retrieve an OKAPI key and [download a database snapshot](https://www.opencaching.de/okapi/services/replicate/fulldump.html).
2. Unpack the downloaded file into a directory starting with `fulldump` (to ignore it on commit by default).
3. Rename the `configuration-example.py` file to `configuration.py`. Edit the file and change the parameters to match your setup.
4. Run `python3 -m load_fulldump` to load the data from the fulldump into the database.
### Running
1. Run `python3 -m perform_update` to update the database. This needs to be executed at least every 10 days, but should not be used with less than 5 minutes apart.
2. Run `python3 -m export_csv` to create the CSV file with the mapping.
### Uploading
1. Run `python3 -m upload_changes` to push the changes to the Git repository.
Please note that this performs a forced push of a re-initialized repository, overwriting the existing Git history. This is done for privacy reasons, as deactivated accounts with their cache data being deleted due to GDPR would still be mappable otherwise. For this reason you should make sure that the remote branch is not protected so it does not deny forced pushes (should be no problem with the default setup on GitHub).
## Development Tasks
### Code Style
After installing [black](https://github.com/psf/black), you should be able to run `black .` from the root directory of this repository to apply auto-formatting.
To check formatting itself, use `flake8 --max-line-length 88 *.py` after installing [flake8](https://gitlab.com/pycqa/flake8).
## License
The tools inside this repository are licensed under the MIT License (see the `LICENSE.md` file for details).
The actual data retrieved from the OKAPI follows the [Opencaching.de data license](https://www.opencaching.de/articles.php?page=impressum&locale=EN), which means you can use them under the terms of the Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Germany (CC BY-NC-ND 3.0 DE) license.