dh1tw/pyhamtools
1
0
Fork 0
mirror of https://github.com/dh1tw/pyhamtools.git synced 2026-01-09 18:21:44 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

improved documentation

Browse source
This commit is contained in:
dh1tw 2014-06-15 15:18:48 +07:00
parent 2d24c32262
commit 00023dc857
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,6 +1,6 @@
# pyhamtools
Pyhamtools is a set of Functions and classes for Amateur Radio software. Currently the core part is the Callsign
Pyhamtools is a set of functions and classes for Amateur Radio purpose. 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.
@ -9,21 +9,24 @@ Currently,
* [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 DX Cluster](https://dxheat.com), performing several thousand lookups per day.
## References
This Library is used in production at the [DXHeat.com DX Cluster](https://dxheat.com), performing several thousand
lookups per day.
## Documentation
Check out the full documentation at:
[PyHamTools.readthedocs.org](pyhamtools.readthedocs.org/en/latest/index.html)
[PyHamTools.readthedocs.org](http://pyhamtools.readthedocs.org/en/latest/index.html)
## Installation
Easiest way to install pyhamtools is through the packet manager PIP:
`pip install pyhamtools`
## How to use pyhamtools
## Example: How to use pyhamtools
```
>>> from pyhamtools import LookupLib, Callinfo