mirror of
https://github.com/dh1tw/pyhamtools.git
synced 2025-12-06 06:52:00 +01:00
59 lines
1.9 KiB
Markdown
59 lines
1.9 KiB
Markdown
# pyhamtools
|
|
|
|
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.
|
|
|
|
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 these lookup services can be accessed through a unified interface.
|
|
|
|
Other modules include location based calculations (e.g. distance, heading between Maidenhead locators) or
|
|
frequency based calculations (e.g. frequency to band).
|
|
|
|
## References
|
|
This Library is used in production at the [DXHeat.com DX Cluster](https://dxheat.com), performing several thousand
|
|
lookups and calculations per day.
|
|
|
|
## Documentation
|
|
Check out the full documentation at:
|
|
[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`
|
|
|
|
## Example: How to use pyhamtools
|
|
|
|
```
|
|
|
|
>>> from pyhamtools.locator import calculate_heading
|
|
>>> calculate_heading("JN48QM", "QF67bf")
|
|
74.3136
|
|
|
|
|
|
>>> from pyhamtools import LookupLib, Callinfo
|
|
>>> my_lookuplib = LookupLib(lookuptype="countryfile")
|
|
>>> cic = Callinfo(my_lookuplib)
|
|
>>> cic.get_all("DH1TW")
|
|
{
|
|
'country': 'Fed. Rep. of Germany',
|
|
'adif': 230,
|
|
'continent': 'EU',
|
|
'latitude': 51.0,
|
|
'longitude': -10.0,
|
|
'cqz': 14,
|
|
'ituz': 28
|
|
}
|
|
|
|
```
|
|
|
|
## Testing
|
|
An extensive set of unit tests has been created for all Classes & Methods. |