improved documentation

This commit is contained in:
dh1tw 2014-06-15 15:13:09 +07:00
parent 91c30879f1
commit 2d24c32262
19 changed files with 79 additions and 66 deletions

View file

@ -1,22 +1,29 @@
# pyhamtools
A Library with Amateur Radio specific Functions and Classes for any kind of Callsign Lookup Service, e.g. Logbooks
or DX-Clusters. Currently,
* [Country-Files.org](http://country-files.org),
Pyhamtools is a set of Functions and classes for Amateur Radio software. Currently the core part is the Callsign
Lookup which decodes any amateur radio callsign string and provides the corresponding information (Country, DXCC entity,
CQ Zone...etc). This basic functionality is needed for Logbooks, DX-Clusters or Log Checking.
Currently,
* [Country-Files.org](http://country-files.org)
* [Clublog Prefixes & Exceptions XML File](https://clublog.freshdesk.com/support/articles/54902-downloading-the-prefixes-and-exceptions-as)
* [Clublog DXCC Query API](http://clublog.freshdesk.com/support/articles/54904-how-to-query-club-log-for-dxcc)
* [Redis.io](http://redis.io)
are supported sources.
All services can be accessed through a unified interface.
This Library is used in production at DxHeat.com.
This Library is used in production at [DXHeat.com DX Cluster](https://dxheat.com), performing several thousand lookups per day.
# Installation
## Documentation
Check out the full documentation at:
[PyHamTools.readthedocs.org](pyhamtools.readthedocs.org/en/latest/index.html)
## Installation
Easiest way to install pyhamtools is through the packet manager PIP:
`pip install pyhamtools'
`pip install pyhamtools`
# How to use pyhamtools
## How to use pyhamtools
```
>>> from pyhamtools import LookupLib, Callinfo
@ -35,5 +42,5 @@ Easiest way to install pyhamtools is through the packet manager PIP:
```
Check out the full documentation at:
[PyHamTools.readthedocs.org](pyhamtools.readthedocs.org/en/latest/index.html)
## Testing
An extensive set of unit tests has been created for all Classes & Methods.