diff --git a/README.md b/README.md index 24aac8e..a8df0be 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file +## Testing +An extensive set of unit tests has been created for all Classes & Methods. \ No newline at end of file diff --git a/docs/build/doctrees/Callinfo.doctree b/docs/build/doctrees/Callinfo.doctree index 18d2438..1f7a5b7 100644 Binary files a/docs/build/doctrees/Callinfo.doctree and b/docs/build/doctrees/Callinfo.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index b62293c..5a2a3d5 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/help.doctree b/docs/build/doctrees/help.doctree index 42e4d5d..afd93ea 100644 Binary files a/docs/build/doctrees/help.doctree and b/docs/build/doctrees/help.doctree differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index cb4b4d8..49dd72f 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/license.doctree b/docs/build/doctrees/license.doctree index 7742cce..ae038a0 100644 Binary files a/docs/build/doctrees/license.doctree and b/docs/build/doctrees/license.doctree differ diff --git a/docs/build/doctrees/lookuplib.doctree b/docs/build/doctrees/lookuplib.doctree index 458a8fa..cc77c17 100644 Binary files a/docs/build/doctrees/lookuplib.doctree and b/docs/build/doctrees/lookuplib.doctree differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index ca19a99..0b03499 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: e213cdbf4e63b1b254214ef0f523c5d7 +config: 841ebbf79ca7b9d13ea1507ed2540934 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/Callinfo.html b/docs/build/html/Callinfo.html index 99225ab..6b1653a 100644 --- a/docs/build/html/Callinfo.html +++ b/docs/build/html/Callinfo.html @@ -6,7 +6,7 @@ - Callinfo — pyhamtools 0.1 documentation + Callinfo — pyhamtools 0.3.1 documentation @@ -14,7 +14,7 @@ - + @@ -43,7 +43,7 @@
  • previous |
  • -
  • pyhamtools 0.1 documentation »
  • +
  • pyhamtools 0.3.1 documentation »
  • @@ -79,7 +79,7 @@ An instance of L
    -get_adif_id(callsign, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 717985, tzinfo=<UTC>))
    +get_adif_id(callsign, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 27244, tzinfo=<UTC>))

    Returns ADIF id of a callsign’s country

    @@ -107,7 +107,7 @@ No Country found for callsign

    -get_all(callsign, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 717985, tzinfo=<UTC>))
    +get_all(callsign, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 27244, tzinfo=<UTC>))

    Lookup a callsign and return all data available from the underlying database

    @@ -160,7 +160,7 @@ would be missing with Clublog (API or XML)
    -get_continent(callsign, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 717985, tzinfo=<UTC>))
    +get_continent(callsign, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 27244, tzinfo=<UTC>))

    Returns the continent Identifier of a callsign

    @@ -201,7 +201,7 @@ No Continent found for callsign

    -get_country_name(callsign, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 717985, tzinfo=<UTC>))
    +get_country_name(callsign, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 27244, tzinfo=<UTC>))

    Returns the country name where the callsign is located

    @@ -239,7 +239,7 @@ for countries. Example:

    -get_cqz(callsign, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 717985, tzinfo=<UTC>))
    +get_cqz(callsign, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 27244, tzinfo=<UTC>))

    Returns CQ Zone of a callsign

    @@ -297,7 +297,7 @@ No callsign found in string
    -get_ituz(callsign, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 717985, tzinfo=<UTC>))
    +get_ituz(callsign, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 27244, tzinfo=<UTC>))

    Returns ITU Zone of a callsign

    @@ -329,7 +329,7 @@ No ITU Zone found for callsign

    -get_lat_long(callsign, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 717985, tzinfo=<UTC>))
    +get_lat_long(callsign, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 27244, tzinfo=<UTC>))

    Returns Latitude and Longitude for a callsign

    @@ -375,7 +375,7 @@ dedicated entry in the database exists.

    -is_valid_callsign(callsign, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 717985, tzinfo=<UTC>))
    +is_valid_callsign(callsign, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 27244, tzinfo=<UTC>))

    Checks if a callsign is valid

    @@ -459,7 +459,7 @@ dedicated entry in the database exists.

  • previous |
  • -
  • pyhamtools 0.1 documentation »
  • +
  • pyhamtools 0.3.1 documentation »
  • @@ -54,7 +54,7 @@
    - + @@ -159,7 +159,7 @@ with some modules and classes which are frequently necessary, like parsing of an
  • next |
  • -
  • pyhamtools 0.1 documentation »
  • +
  • pyhamtools 0.3.1 documentation »
  • @@ -151,7 +151,7 @@ u’longitude’: -177.08
    -is_invalid_operation(callsign, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 706858, tzinfo=<UTC>))
    +is_invalid_operation(callsign, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 26185, tzinfo=<UTC>))

    Returns True if an operations is known as invalid

    Version:0.1
    Version:0.3.1
    Code:https://github.com/dh1tw/pyhamtools
    @@ -207,7 +207,7 @@ API Key for Clublog missing or incorrect
    -lookup_callsign(callsign=None, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 706831, tzinfo=<UTC>))
    +lookup_callsign(callsign=None, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 26163, tzinfo=<UTC>))

    Returns lookup data if an exception exists for a callsign

    @@ -313,7 +313,7 @@ the id 273.

    -lookup_prefix(prefix, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 706831, tzinfo=<UTC>))
    +lookup_prefix(prefix, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 26163, tzinfo=<UTC>))

    Returns lookup data of a Prefix

    @@ -371,7 +371,7 @@ database (default database).

    -lookup_zone_exception(callsign, timestamp=datetime.datetime(2014, 6, 15, 7, 5, 27, 706866, tzinfo=<UTC>))
    +lookup_zone_exception(callsign, timestamp=datetime.datetime(2014, 6, 15, 8, 12, 7, 26192, tzinfo=<UTC>))

    Returns a CQ Zone if an exception exists for the given callsign

    Args: callsign (string): Amateur radio callsign @@ -463,7 +463,7 @@ in CQ Zone 38

  • previous |
  • -
  • pyhamtools 0.1 documentation »
  • +
  • pyhamtools 0.3.1 documentation »
  • @@ -113,7 +113,7 @@
  • modules |
  • -
  • pyhamtools 0.1 documentation »
  • +
  • pyhamtools 0.3.1 documentation »
  • @@ -94,7 +94,7 @@
  • modules |
  • -
  • pyhamtools 0.1 documentation »
  • +
  • pyhamtools 0.3.1 documentation »