w1cdn/spothole
1
0
Fork 0
mirror of https://git.ianrenton.com/ian/spothole.git synced 2025-10-27 08:49:27 +00:00
Code Issues 11 Packages Projects Releases Wiki Activity

Support Clublog lookup #38

Browse Source
This commit is contained in:
Ian Renton
2025-10-12 16:13:31 +01:00
parent b61f08768c
commit 6b57891028
11 changed files with 156 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -34,7 +34,15 @@ cp config-example.yml config.yml
Then edit `config.yml` in your text editor of choice to set up the software as you like it.
Then, to run the software this time and any future times you want to run it directly from the command line:
`config.yml` has some entries for QRZ.com username & password, and Clublog API keys. If provided, these allow Spothole to retrieve more information about DX spots, such as the country their callsign corresponds to. The software will work just fine without them, but you may find a few country flags etc. are less accurate or missing.
Clublog API keys are free, but you'll need to get your own by submitting a helpdesk ticket and explaining what you'll use it for. The admin team are happy with the rate of requests made by my Spothole server, so unless you change the source code of yours to radically increase the rate of querying Clublog, I'm sure they will be fine with your server too.
Free QRZ.com accounts offer only limited access to the site's data via their API. You'll have to sign up for one of their "XML Data Subscriber" plans to gain access to the full data, but if you're on a free account then the software will get what information it can.
Once you're happy with the content of `config.yml`, you can proceed to running the software.
To run the software this time and any future times you want to run it directly from the command line:
```bash
source .venv/bin/activate
@@ -164,6 +172,7 @@ To navigate your way around the source code, this list may help.
* `/` - Main script (`spothole.py`), pip `requirements.txt`, config, README, etc.
* `/images` - Image sources
* `/cache` - Directory where static-ish data downloaded from the internet is cached to avoid rapid re-requests, and where spot/alert data is cached so that it survives a software restart. Created on first run.
### Extending the server