odie/qrzlogger
1
0
Fork 0
mirror of https://codeberg.org/mclemens/qrzlogger.git synced 2024-11-16 13:16:07 -05:00
Code Issues Packages Projects Releases Wiki Activity

added installation instructions to README

Browse Source 
added requests to needed libraries
This commit is contained in:
Michael Clemens 2021-06-02 09:33:25 +02:00
parent 41993577eb
commit 091feae555
3 changed files with 30 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -14,28 +14,38 @@ It does the following:
![screenshot](/screenshot.jpg?raw=true "screenshot")
# Dependencies
# Installation
qrzlogger needs the following libraries:
qrzlogger needs Python 3 and the following libraries:
* xmltodict
* prettytable
* colored
These libraries can be installed with the following command:
```
# sudo pip install xmltodict prettytable colored
```
* requests
Furthermore, you need at least the XML subscription from QRZ.com.
# Installation
Before installing qrzlogger, please make sure that pip, setuptools and wheel are installed and up-to-date:
* install via pip with "pip3 install qrzlogger"
* execute with "qrzlogger"
* the application creates a default config file and states its location (_~/.qrzlogger.ini_)
* adapt _~/.qrzlogger.ini_ to your needs
```
# python3 -m pip install --upgrade pip setuptools wheel
```
Finally, install qrzlogger with pip:
```
# python3 -m pip install qrzlogger
```
# Usage
* execute the application with "qrzlogger"
* qrzlogger creates a default config file and states its location (e.g. _~/.qrzlogger.ini_)
* adapt _~/.qrzlogger.ini_ to your needs. Important setting are:
* station_call: This is your station call (must match with the QRZ.com logbook)
* api_key: Your QRZ.com API key. You find it under "settings" in the QRZ.com logbook'
* qrz_user: Your QRZ.com user name, typically your call sign'
* qrz_pass: Your QRZ.com password (not the API key)'
* execute the application again with "qrzlogger"
# License

3
setup.cfg
View File

@ -1,6 +1,6 @@
[metadata]
name = qrzlogger
version = 0.6
version = 0.6.1
author = Michael Clemens
author_email = qrzlogger@qrz.is
description = A python application to log QSOs directly to QRZ.com from the command line
@ -24,6 +24,7 @@ install_requires=
xmltodict
prettytable
colored
requests
[options.packages.find]
where = src

10
src/qrzlogger/__main__.py
View File

@ -84,10 +84,10 @@ class QRZLogger():
else:
config = configparser.ConfigParser()
config['qrz.com'] = {
'station_call': 'MYCALL # Enter here your station call (must match with the QRZ.com logbook)',
'api_key': '1234-ABCD-1234-A1B2 # Enter here you API key. You find it under "settings" in the QRZ.com logbook',
'qrz_user': 'N0CALL # Enter here you QRZ.com user name, typically your call sign',
'qrz_pass': 'q1w2e3r4t5z6u7i8o9 # Enter here you QRZ.com password (not the API key)',
'station_call': 'MYCALL',
'api_key': '1234-ABCD-1234-A1B2',
'qrz_user': 'MYCALL',
'qrz_pass': 'my_secret_password',
'xml_fields': '("call", "band", "mode", "qso_date", "time_on", "rst_sent", "rst_rcvd", "comment")'}
config['log'] = {
'log_file': '/tmp/qrzlogger.log'}
@ -479,7 +479,7 @@ class QRZLogger():
print(" __ _ _ _ __| |___ __ _ __ _ ___ _ _ ")
print(" / _` | '_|_ / / _ \/ _` / _` / -_) '_|")
print(" \__, |_| /__|_\___/\__, \__, \___|_| ")
print(" |_| DL6MHC |___/|___/ v0.6 " + style.RESET)
print(" |_| DL6MHC |___/|___/ v0.6.1 " + style.RESET)