improved README, switched to waitress

This commit is contained in:
Michael Clemens 2023-02-09 19:00:46 +01:00
parent 726de1e7f3
commit 3954a4cab1
2 changed files with 9 additions and 4 deletions

View File

@ -6,6 +6,7 @@ import configparser
from pathlib import Path from pathlib import Path
from flask import Flask, jsonify, request, Response from flask import Flask, jsonify, request, Response
from flask_restful import Resource, Api from flask_restful import Resource, Api
from waitress import serve
import requests import requests
from requests.structures import CaseInsensitiveDict from requests.structures import CaseInsensitiveDict
@ -47,7 +48,7 @@ class QRZ():
'url': 'https://logbook.qrz.com/api'} 'url': 'https://logbook.qrz.com/api'}
config['general'] = { config['general'] = {
'api_key': 'API_KEY_FOR_THIS_API', 'api_key': 'API_KEY_FOR_THIS_API',
'install_path': '/log/' 'install_path': '/'
} }
with open(file_name, 'w') as configfile: with open(file_name, 'w') as configfile:
@ -164,4 +165,5 @@ if __name__ == '__main__':
qrz = QRZ() qrz = QRZ()
api.add_resource(ApiTest, qrz.config['general']['install_path'] + 'index.php/api/auth/<string:key>' ) api.add_resource(ApiTest, qrz.config['general']['install_path'] + 'index.php/api/auth/<string:key>' )
api.add_resource(UploadQso, qrz.config['general']['install_path'] + 'index.php/api/qso') api.add_resource(UploadQso, qrz.config['general']['install_path'] + 'index.php/api/qso')
app.run(debug=True) #app.run(debug=True)
serve(app, host='127.0.0.1', port=5000)

View File

@ -2,12 +2,15 @@
API server emulating a [Cloudlog](https://github.com/magicbug/Cloudlog) instance that receives QSOs from [CloudLogOffline](https://github.com/myzinsky/cloudLogOffline) and sends them to a defined QRZ.com logbook. API server emulating a [Cloudlog](https://github.com/magicbug/Cloudlog) instance that receives QSOs from [CloudLogOffline](https://github.com/myzinsky/cloudLogOffline) and sends them to a defined QRZ.com logbook.
This enables you to use the fantastic App CloudLogOffline to log QSOs for example with your phone when you are portable and have no cell service. Afterwards you can export all new QSOs via CloudlogOffline2QRZ directly into your QRZ.com logbook. CloudlogOffline2QRZ acts as a middleman by pretendig to be a Cloudlog server, receiving the QSOs and then uploading them via the QRZ.com API to your QRZ logbook. For this you need to execute CloudlogOffline2QRZ for example on a VPS behind a web server.
# Installation # Installation
qrzlogger needs Python 3 and the following libraries: CloudlogOffline2QRZ needs Python 3 and the following libraries:
* flask * flask
* flask-restful * flask-restful
* waitress
Furthermore, you need at least the XML subscription from QRZ.com. Furthermore, you need at least the XML subscription from QRZ.com.
@ -16,6 +19,7 @@ Before installing CloudlogOffline2QRZ, please make sure that the above mentioned
``` ```
# python3 -m pip install flask # python3 -m pip install flask
# python3 -m pip install flask-restful # python3 -m pip install flask-restful
# python3 -m pip install waitress
``` ```
To download or update qrzlogger, clone the repo: To download or update qrzlogger, clone the repo:
@ -42,7 +46,6 @@ Configure your web server as a reverse proxy to forward requests sent to a certa
* API Key: same as general/api_key (see above). * API Key: same as general/api_key (see above).
* Station ID: doesn't matter * Station ID: doesn't matter
# License # License
see ![LICENSE](LICENSE) see ![LICENSE](LICENSE)