PyQSO is a contact logging tool for amateur radio operators.
 
 
Go to file
Christian T. Jacobs 9194a71a99 homogeneous, spacing. 2017-04-20 23:10:06 +01:00
bin Moved Glade file and icon files to a new directory called 'res'. 2017-04-02 14:02:40 +01:00
docs Updated pyqso.rst. 2017-04-15 01:23:20 +01:00
pyqso homogeneous, spacing. 2017-04-20 23:10:06 +01:00
res Added tests for the Summary class. 2017-04-20 22:50:08 +01:00
tests Rename get_all_records to records and decorate it. 2017-04-20 22:57:17 +01:00
.gitignore Tell Git to ignore the ADIF files generated for the unittests. 2015-02-16 10:56:16 +00:00
.travis.yml Importing the modules required for the unit tests. 2017-04-15 01:19:44 +01:00
CHANGELOG.md Updated CHANGELOG. 2017-04-15 01:31:13 +01:00
COPYING Added some core files for the PyQSO program: 2013-03-22 22:16:31 +00:00
Makefile Moved all the unittests to a new directory called 'tests'. The command 'make test' now looks in the 'tests' directory. 2017-04-15 01:14:17 +01:00
README.md Use a comma rather than placing my callsign in brackets after my name. 2017-04-01 15:20:33 +01:00
setup.py Moved Glade file and icon files to a new directory called 'res'. 2017-04-02 14:02:40 +01:00
tox.ini Exclude more directories from flake8. 2016-01-27 17:17:03 +00:00

README.md

Copyright (C) 2013-2017 Christian Thomas Jacobs.

This file is part of PyQSO.

PyQSO is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

PyQSO is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with PyQSO.  If not, see <http://www.gnu.org/licenses/>.

PyQSO

PyQSO is a contact logging tool for amateur radio operators.

Build Status Documentation Status

Installation and running

Assuming that the current working directory is PyQSO's base directory (the directory that the Makefile is in), PyQSO can be installed via the terminal with the following command:

make install

Note: 'sudo' may be needed for this. Once installed, the following command will run PyQSO:

pyqso

Alternatively, PyQSO can be run (without installing) with:

python3 bin/pyqso

from PyQSO's base directory.

Documentation

The PyQSO documentation is stored in the docs directory. It can be built with the following command:

make docs

which will produce an HTML version of the documentation in docs/build/html that can be opened in a web browser.

Alternatively, a ready-built version of the PyQSO documentation can be found on Read the Docs.

Dependencies

PyQSO depends on the following Debian packages:

  • gir1.2-gtk-3.0
  • python3
  • python3-gi-cairo (for log printing purposes)

The following extra packages are necessary to fully enable the grey line tool and the plotting of logbook statistics:

  • python3-matplotlib (version 1.3.0 or later)
  • python3-mpltoolkits.basemap
  • python3-numpy
  • libxcb-render0-dev
  • python3-cairocffi
  • geocoder (installable via pip and used for QTH lookups)

The following extra package is necessary to build the documentation:

  • python3-sphinx

There currently does not exist a Python 3-compatible Debian package for Hamlib. This library must be built manually to enable Hamlib support.

Contact

If you have any comments or questions about PyQSO please send them via email to Christian Jacobs, M0UOS, at christian@christianjacobs.uk.