qspylib 0.0.1__tar.gz

qspylib-0.0.1/.github/workflows/python-package.yml

@@ -0,0 +1,40 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

qspylib-0.0.1/.gitignore

@@ -0,0 +1,3 @@
+/.pytest_cache
+/.vscode
+/src/qspylib/__pycache__

qspylib-0.0.1/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

qspylib-0.0.1/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.3
+Name: qspylib
+Version: 0.0.1
+Summary: A set of amateur radio website API wrappers
+Project-URL: Homepage, https://github.com/JayToTheAy/QSPy
+Project-URL: Issues, https://github.com/JayToTheAy/QSPy/issues
+Author-email: Jacob Humble <contact@jacobhumble.com>
+License-File: LICENSE
+Keywords: API,LOTW,QRZ,amateur radio,eQSL
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: adif-io
+Requires-Dist: requests
+Requires-Dist: xmltodict
+Description-Content-Type: text/markdown
+
+# QSPyLib
+![Python Package Build Action Status](https://github.com/JayToTheAy/QSPy/actions/workflows/python-package.yml/badge.svg)
+
+QSPyLib is a bundle of API wrappers for various amateur radio-related websites, including QRZ, LOTW, eQSL, and ClubLog.
+
+It is currently in development and should be considered unstable version-to-version while the version number is still 0.x.x.
+
+Issues and pull requests are welcome, and should be made on the [GitHub repository](https://github.com/jaytotheay/qspy).
+
+## What works right now?
+
+As of v0.0.1:
+
+* The LotW module is, in theory, finished -- no doubt something will come up about how it's not actually practical and needs more work.
+* The eQSL module has most of the functionality of eQSL's API, but is incredibly unpolished and needs more work.
+* The QRZ module exists; the Logbook API is currently only supported for FETCH operations, and the XML Interface is not supported yet.
+* The ClubLog module is on-hold pending the ready-status of the other modules.
+
+## How do I use it?
+
+An example of pulling a Logbook from LOTW:
+
+```py
+from qspylib import lotw
+LOTWAccount = lotw.LOTWSession("callsign", "password")
+logbook = LOTWAccount.fetch_logbook()
+```
+This will give you a `Logbook` object, which contains a list of QSO objects and a parsed, usable adif_io log. The adif_io log property contains all the ADIF info that LOTW outputs (and likewise for other logging sites); the built-in log property of a `Logbook` object contains only some limited information, like callsign, band, mode, date, time, and QSL status from the originating site (which is a little handy as a single-reference for if a QSO is a QSL, since different sites use different, extra ADIF fields to express being QSL'd on their platform.)
+
+Other functions of APIs are generally available, like checking if an eQSL is verified:
+
+```py
+from qspylib import eqsl
+confirmed, raw_result = eqsl.verify_eqsl('N5UP', 'TEST', '160m', 'SSB', '01/01/2000')
+```
+This will return a tuple; here, `confirmed` will be False, since this QSO is not verified on eQSL, and `raw_result` will contain any extra information eQSL provides, for instance, if it's Authenticity Guaranteed.
+
+The best way to find out the functions, methods and objects available is to code dive; an okay-amount-of-effort has been put in to documenting the code with doc strings. 

qspylib-0.0.1/README.md

@@ -0,0 +1,38 @@
+# QSPyLib
+![Python Package Build Action Status](https://github.com/JayToTheAy/QSPy/actions/workflows/python-package.yml/badge.svg)
+
+QSPyLib is a bundle of API wrappers for various amateur radio-related websites, including QRZ, LOTW, eQSL, and ClubLog.
+
+It is currently in development and should be considered unstable version-to-version while the version number is still 0.x.x.
+
+Issues and pull requests are welcome, and should be made on the [GitHub repository](https://github.com/jaytotheay/qspy).
+
+## What works right now?
+
+As of v0.0.1:
+
+* The LotW module is, in theory, finished -- no doubt something will come up about how it's not actually practical and needs more work.
+* The eQSL module has most of the functionality of eQSL's API, but is incredibly unpolished and needs more work.
+* The QRZ module exists; the Logbook API is currently only supported for FETCH operations, and the XML Interface is not supported yet.
+* The ClubLog module is on-hold pending the ready-status of the other modules.
+
+## How do I use it?
+
+An example of pulling a Logbook from LOTW:
+
+```py
+from qspylib import lotw
+LOTWAccount = lotw.LOTWSession("callsign", "password")
+logbook = LOTWAccount.fetch_logbook()
+```
+This will give you a `Logbook` object, which contains a list of QSO objects and a parsed, usable adif_io log. The adif_io log property contains all the ADIF info that LOTW outputs (and likewise for other logging sites); the built-in log property of a `Logbook` object contains only some limited information, like callsign, band, mode, date, time, and QSL status from the originating site (which is a little handy as a single-reference for if a QSO is a QSL, since different sites use different, extra ADIF fields to express being QSL'd on their platform.)
+
+Other functions of APIs are generally available, like checking if an eQSL is verified:
+
+```py
+from qspylib import eqsl
+confirmed, raw_result = eqsl.verify_eqsl('N5UP', 'TEST', '160m', 'SSB', '01/01/2000')
+```
+This will return a tuple; here, `confirmed` will be False, since this QSO is not verified on eQSL, and `raw_result` will contain any extra information eQSL provides, for instance, if it's Authenticity Guaranteed.
+
+The best way to find out the functions, methods and objects available is to code dive; an okay-amount-of-effort has been put in to documenting the code with doc strings. 

qspylib-0.0.1/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "qspylib"
+version = "0.0.1"
+dependencies = [
+  "adif_io",
+  "requests",
+  "xmltodict",
+]
+requires-python = ">=3.9"
+authors = [
+  { name="Jacob Humble", email="contact@jacobhumble.com" },
+]
+description = "A set of amateur radio website API wrappers"
+readme = "README.md"
+keywords = ["QRZ", "LOTW", "eQSL", "API", "amateur radio"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
+    "Operating System :: OS Independent",
+    "Development Status :: 2 - Pre-Alpha"
+]
+
+[project.urls]
+Homepage = "https://github.com/JayToTheAy/QSPy"
+Issues = "https://github.com/JayToTheAy/QSPy/issues"

qspylib-0.0.1/src/qspylib/__init__.py

@@ -0,0 +1,11 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+# imports
+from .logbook import QSO, Logbook
+from .lotw import LOTWSession, get_last_upload, upload_logbook
+from .clublog import ClubLogWrapper
+from .qrz import QRZLogbookAPI, QRZXMLInterface
+from .eqsl import eQSLSession, verify_eqsl, retrieve_graphic, get_ag_list, get_ag_list_dated, get_full_member_list, get_users_data
+

qspylib-0.0.1/src/qspylib/clublog.py

@@ -0,0 +1,33 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+import requests
+from qspylib.logbook import Logbook
+
+class ClubLogWrapper:
+    """
+    API wrapper for ClubLog. At present, only handles fetching QSOs.
+    Fetching returns a Logbook object that must be assigned to something.
+    """
+
+    def __init__(self, email: str, callsign: str, password: str):
+        self.email = email
+        self.callsign = callsign
+        self.password = password
+        self.base_url = "https://clublog.org/getadif.php"
+    
+    def fetch_logbook(self):
+        data = {
+            'email': self.email,
+            'password': self.password,
+            'call': self.callsign
+        }
+        # filter down to only used params
+        data = {k: v for k, v in data.items() if v is not None}
+
+        response = requests.post(self.base_url, data=data)
+        if response.status_code == 200:
+            return Logbook(self.callsign, response.text)
+        else:
+            response.raise_for_status()

qspylib-0.0.1/src/qspylib/eqsl.py

@@ -0,0 +1,197 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+from qspylib.logbook import Logbook
+import requests
+
+# functions that don't require authentication
+
+def verify_eqsl(CallsignFrom: str, CallsignTo: str, QSOBand: str, QSOMode: str = None, QSODate: str = None, timeout: int = 15):
+    """
+    Verify a QSL with eQSL. Returns a tuple containing a Boolean of whether the QSO was verified, and the result str with any extra information.
+
+    Keyword arguments:
+
+    CallsignFrom -- Callsign originating QSO (i.e. N5UP)
+    CallsignTo -- Callsign receiving QSO (i.e. TEST)
+    QSOBand -- Band QSO took place on (i.e. 160m)
+    QSOMode -- Mode QSO took place with (i.e. SSB)
+    QSODate -- Date QSO took place (i.e. 01/31/2000)
+    """
+    url = "https://www.eqsl.cc/qslcard/VerifyQSO.cfm"
+    params = {
+        'CallsignFrom': CallsignFrom,
+        'CallsignTo': CallsignTo,
+        'QSOBand': QSOBand,
+        'QSOMode': QSOMode,
+        'QSODate': QSODate,
+    }
+
+    with requests.Session() as s:
+        r = s.get(url, params=params, headers={'user-agent': 'pyQSP/0.0.1'}, timeout=timeout)
+        if r.status_code == 200:
+            raw_result = r.text
+            if 'Result - QSO on file' in raw_result:
+                return True, raw_result
+            elif 'Parameter missing' not in raw_result:
+                return False, raw_result
+            else:
+                raise Exception(raw_result)
+        else:
+            r.raise_for_status()
+
+def retrieve_graphic():
+    raise NotImplementedError
+
+def get_ag_list(timeout: int = 15):
+    """Get a list of Authenticity Guaranteed members. Tuple contains a list of string callsigns, and a string header with the date the list was generated."""
+
+    url = "https://www.eqsl.cc/qslcard/DownloadedFiles/AGMemberList.txt"
+
+    with requests.Session() as s:
+        r = s.get(url, headers={'user-agent': 'pyQSP/0.0.1'}, timeout=timeout)
+        if r.status_code == 200:
+            result_list = list()
+            result_list += r.text.split('\r\n')
+            return set(result_list[1:-1]), str(result_list[0])
+        else:
+            r.raise_for_status()
+
+def get_ag_list_dated(timeout: int = 15):
+    """
+    Get a list of Authenticity Guaranteed eQSL members with the date of their last upload to eQSL.
+    Returns a tuple. First element is a dict with key: callsign and value: date, and second is a header of when this list was generated.
+    """
+    url = "https://www.eqsl.cc/qslcard/DownloadedFiles/AGMemberListDated.txt"
+
+    with requests.Session() as s:
+        r = s.get(url, headers={'user-agent': 'pyQSP/0.0.1'}, timeout=timeout)
+        if r.status_code == 200:
+            result_list = r.text.split('\r\n')
+            loc, header = result_list[1:-1], str(result_list[0])
+            dict_calls = dict()
+            for pair in loc:
+                call, date = pair.split(', ')
+                dict_calls[call] = date
+            return dict_calls, header
+        else:
+            r.raise_for_status()
+
+def get_full_member_list(timeout: int = 15):
+    """Get a list of all members of QRZ. Returns a dict, where the key is the callsign and the value is a tuple of: GridSquare, AG, Last Upload"""
+
+    url = "https://www.eqsl.cc/DownloadedFiles/eQSLMemberList.csv"
+
+    with requests.Session() as s:
+        r = requests.get(url, timeout=timeout)
+        if r.status_code == 200:
+            result_list = r.text.split('\r\n')[1:-1]
+            dict_calls = dict()
+            for row in result_list:
+                data = row.split(',')
+                dict_calls[data[0]] = data[1:]
+            return dict_calls
+        else:
+            r.raise_for_status()
+
+def get_users_data(callsign: str, timeout: int = 15):
+    """
+    Returns a dict of data on a QRZ user, in the form of: GridSquare, AG, Last Upload
+    Note: Slow. Would be faster with vectorization, but then we'd need dependencies.
+    """
+    dict_users: dict = get_full_member_list()
+    return dict_users.get(callsign)
+
+
+# things that require authentication
+class eQSLSession:
+    """
+    API wrapper for eQSL. At present, only handles fetching inbox QSOs.
+    Fetching returns a Logbook object that must be assigned to something.
+    """
+
+    def __init__(self, username: str, password: str, QTHNickname: str = None, timeout: int = 15):
+        self.callsign = username,
+        self.timeout = timeout
+        self.base_url = "https://www.eqsl.cc/qslcard/"
+
+        session = requests.Session()
+
+        session.params = {k: v for k, v in {
+            'username': username,
+            'password': password,
+            'QTHNickname': QTHNickname }.items() if v is not None}
+
+        session.headers = {'User-Agent': 'pyQSP/0.0.1'}
+        self.session = session
+    
+    def set_timeout(self, timeout: int):
+        self.timeout = timeout
+    
+    # actual GETs
+
+    def get_last_upload_date(self):
+        " Returns a string with the date of last upload for the active user. Date is formatted: DD-MMM-YYYY at HH:mm UTC"
+
+        with self.session as s:
+            r = s.get(self.base_url + 'DisplayLastUploadDate.cfm', timeout=self.timeout)
+            if r.status_code == 200:
+                success_txt = 'Your last ADIF upload was'
+                if success_txt in r.text:
+                    return r.text[r.text.index('(')+1:r.text.index(')')]
+                else:
+                    raise Exception(r.text)
+
+    def fetch_inbox(self, LimitDateLo=None, LimitDateHi=None, RcvdSince=None, ConfirmedOnly=None, UnconfirmedOnly=None, Archive=None, HamOnly=None):
+        params = {
+            'LimitDateLo': LimitDateLo,
+            'LimitDateHi': LimitDateHi,
+            'RcvdSince': RcvdSince,
+            'ConfirmedOnly': ConfirmedOnly,
+            'UnconfirmedOnly': UnconfirmedOnly,
+            'Archive': Archive,
+            'HamOnly': HamOnly
+        }
+        # filter down to only used params
+        params = {k: v for k, v in params.items() if v is not None}
+
+        with self.session as s:
+            r = s.get(self.base_url + "DownloadInBox.cfm", params=params, timeout=self.timeout)
+            if r.status_code == 200:
+                adif_found_txt = 'Your ADIF log file has been built'
+                adif_status = r.text.index(adif_found_txt) if adif_found_txt in r.text else -1
+                if adif_status < 0:
+                    raise Exception('Failed to generate ADIF.')
+                adif_link_start_idx = r.text.index('<LI><A HREF="..') + 15
+                adif_link_end_idx = r.text.index('">.ADI file</A>')
+                adif_link = self.base_url + r.text[adif_link_start_idx:adif_link_end_idx]
+                adif_response = requests.get(adif_link)
+                if adif_response.status_code == 200:
+                    return Logbook(self.callsign, adif_response.text)
+                else:
+                    r.raise_for_status()
+            else:
+                r.raise_for_status()
+
+    def fetch_outbox(self):
+        # TO-DO: test
+        with self.session as s:
+            r = s.get(self.base_url + "DownloadADIF.cfm", timeout=self.timeout)
+            if r.status_code == 200:
+                adif_found_txt = 'Your ADIF log file has been built'
+                adif_status = r.text.index(adif_found_txt) if adif_found_txt in r.text else -1
+                if adif_status < 0:
+                    raise Exception('Failed to generate ADIF.')
+                adif_link_start_idx = r.text.index('<LI><A HREF="..') + 15
+                adif_link_end_idx = r.text.index('">.ADI file</A>')
+                adif_link = self.base_url + r.text[adif_link_start_idx:adif_link_end_idx]
+                adif_response = requests.get(adif_link)
+                if adif_response.status_code == 200:
+                    return Logbook(self.callsign, adif_response.text)
+                else:
+                    r.raise_for_status()
+            else:
+                r.raise_for_status()
+
+    

qspylib-0.0.1/src/qspylib/logbook.py

@@ -0,0 +1,51 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+import adif_io
+
+class QSO:
+    """
+    A hambaseio QSO obj. Contains simple info on a QSO.
+    """
+    def __init__(self, their_call, band, mode, qso_date, time_on, qsl_rcvd='N'): 
+        self.their_call = their_call
+        self.band = band
+        self.mode = mode
+        self.qso_date = qso_date
+        self.time_on = time_on
+        self.qsl_rcvd = qsl_rcvd
+
+    def __str__(self):
+        return f"CALL: {self.their_call} BAND: {self.band} MODE: {self.mode} DATE: {self.qso_date} TIME: {self.time_on} QSL: {self.qsl_rcvd}\n"
+        # to-do: make this return as an actual adif formattede string
+
+class Logbook:
+    """
+    A Logbook has both an adi field, holding all fields parsed from an .adi log per QSO, and a simplified log field, holding a simplified set of fields per QSO.
+    Interacting with the log field can provide one field to check for if a QSO is confirmed on one or more of: LoTW, eQSL, QRZ, or ClubLog. 
+    """
+
+    def __init__(self, callsign: str, unparsed_log: str):
+        self.callsign = callsign
+        self.adi, self.header = adif_io.read_from_string(unparsed_log)
+        self.log = set()
+        for contact in self.adi:
+            # whether this qsl has been confirmed; lotw & clublog use qsl_rcvd, eqsl uses eqsl_qsl_rcvd, qrz most simply gives a qsl date
+            qsl_rcvd, qrz_qsl_dte, eqsl_qsl_rcvd = contact.get('QSL_RCVD'), contact.get('app_qrzlog_qsldate'), contact.get('eqsl_qsl_rcvd')
+            qso_confirmed = 'Y' if qsl_rcvd == 'Y' or qrz_qsl_dte or eqsl_qsl_rcvd == 'Y' else 'N'
+            # create a QSO for this contact
+            self.log.add(QSO(contact['CALL'], contact['BAND'], contact['MODE'], contact['QSO_DATE'], contact['TIME_ON'], qso_confirmed))
+
+    def __str__(self):
+        log_str = ""
+        for qso in self.log:
+            log_str += str(qso)
+        return log_str
+
+    def write_qso(self, contact: QSO):
+        self.log.add(contact)
+
+    def discard_qso(self, contact: QSO):
+        self.log.discard(contact)
+        # to-do: discrad from adi?

qspylib-0.0.1/src/qspylib/lotw.py

@@ -0,0 +1,158 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+import requests
+from qspylib.logbook import Logbook
+
+# exceptions
+
+class RetrievalFailure(Exception):
+    def __init__(self, message="Failed to retrieve information. Confirm log-in credentials are correct."):
+        self.message=message
+        super().__init__(self, message)
+
+class UploadFailure(Exception):
+    def __init__(self, message="Failed to upload file."):
+        self.message=message
+        super().__init__(self, message)
+
+# functions
+
+def get_last_upload(timeout: int = 15):
+    """Queries LOTW for a list of callsigns and date they last uploaded. Returns a csv."""
+
+    url = 'https://lotw.arrl.org/lotw-user-activity.csv'
+
+    with requests.Session() as s:
+        response = s.get(url, timeout=timeout)
+        if response.status_code == 200:
+            return response.text
+        else:
+            response.raise_for_status()
+
+def upload_logbook(file, timeout:int=120):
+    """
+    Given a .tq5 or .tq8, uploads it to LOTW. Throws an error for a connection error or if a file is rejected by LOTW, and gives the error.
+    Returns the upload result message, if any.
+    TO-DO: Test this actually works.
+    """
+
+    upload_url = "https://lotw.arrl.org/lotw/upload"
+
+    data = {'upfile': file}
+
+    with requests.Session() as s:
+        response = s.post(upload_url, data, timeout=timeout)
+        if response.status_code == 200:
+            result = response.text
+            result_start_idx = result.index('<!-- .UPL. ')
+            result_end_idx = result[result_start_idx + 11:].index(' -->')
+            upl_result = result[result_start_idx:result_end_idx]
+            upl_message = str(result[result.index('<!-- .UPLMESSAGE. ') + 18:result[result_end_idx:].rindex(' -->')])
+            if 'rejected' in upl_result:
+                raise UploadFailure(upl_message)
+            else:
+                return upl_message
+        else:
+            response.raise_for_status()
+
+class LOTWSession:
+    """
+    Wrapper for LOTW API functionality that requires a logged-in session.
+    Fetching returns a Logbook object that must be assigned to something.
+    """
+
+    def __init__(self, username: str, password: str):
+        self.username = username
+        self.password = password
+        self.base_url = "https://lotw.arrl.org/lotwuser/"
+
+        session = requests.Session()
+        session.params = {'login': username,
+                          'password': password }
+        session.headers = {'User-Agent': 'pyQSP/0.0.1'}
+
+        self.session = session
+
+    def fetch_logbook(self, qso_query=1, qso_qsl='yes', qso_qslsince=None, qso_qsorxsince=None, qso_owncall=None, 
+                      qso_callsign=None,qso_mode=None,qso_band=None,qso_dxcc=None,qso_startdate=None, qso_starttime=None, 
+                      qso_enddate=None, qso_endtime=None, qso_mydetail=None,qso_qsldetail=None, qsl_withown=None):
+        """
+        Fetch a logbook from LOTW.
+
+        Keyword arguments:
+
+        qso_query --  If absent, ADIF file will contain no QSO records (default 1)
+        qso_qsl --  opt, If "yes", only QSL records are returned (can be 'yes' or 'no', default 'yes')
+        qso_qslsince -- opt, QSLs since specified datetime (YYYY-MM-DD HH:MM:SS). Ignored unless qso_qsl="yes".
+        qso_qsorxsince -- opt, QSOs received since specified datetime. Ignored unless qso_qsl="no".
+        qso_owncall -- opt, returns records where "own" call sign matches
+        qso_callsign --  opt, returns records where "worked" call sign matches
+        qso_mode --  opt, returns records where mode matches
+        qso_band -- opt, returns records where band matches
+        qso_dxcc -- opt, returns matching DXCC entities, implies qso_qsl='yes'
+        qso_startdate --  opt, Returns only records with a QSO date on or after the specified value.
+        qso_starttime -- opt, Returns only records with a QSO time at or after the specified value on the starting date. This value is ignored if qso_startdate is not provided.
+        qso_enddate -- opt, Returns only records with a QSO date on or before the specified value.
+        qso_endtime --  opt, Returns only records with a QSO time at or before the specified value on the ending date. This value is ignored if qso_enddate is not provided.
+        qso_mydetail -- opt,  If "yes", returns fields that contain the Logging station's location data, if any.
+        qso_qsldetail -- opt, If "yes", returns fields that contain the QSLing station's location data, if any.
+        qsl_withown -- opt, If "yes", each record contains the STATION_CALLSIGN and APP_LoTW_OWNCALL fields to identify the "own" call sign used for the QSO.
+        """
+        log_url = "lotwreport.adi"
+
+        params = {
+            'qso_query': qso_query,
+            'qso_qsl' :  qso_qsl,
+            'qso_qslsince': qso_qslsince,
+            'qso_qsorxsince': qso_qsorxsince,
+            'qso_owncall': qso_owncall,
+            'qso_callsign': qso_callsign,
+            'qso_mode': qso_mode,
+            'qso_band': qso_band,
+            'qso_dxcc': qso_dxcc,
+            'qso_startdate': qso_startdate,
+            'qso_starttime': qso_starttime,
+            'qso_enddate': qso_enddate,
+            'qso_endtime': qso_endtime,
+            'qso_mydetail': qso_mydetail,
+            'qso_qsldetail': qso_qsldetail,
+            'qsl_withown': qsl_withown
+        }
+        # filter down to only used params
+        params = {k: v for k, v in params.items() if v is not None}
+
+        with self.session as s:
+            response = s.get(self.base_url + log_url, params=params)
+            if '<eoh>' not in response.text:
+                raise RetrievalFailure
+            if response.status_code == 200:
+                return Logbook(self.username, response.text)
+            else:
+                response.raise_for_status()
+
+    def get_dxcc_credit(self, entity:str=None, ac_acct:str=None):
+        """
+        Gets DXCC award account credit, optionally for a specific DXCC Entity Code specified via entity.
+        Note: This only returns *applied for and granted credit*, not 'presumed' credits.
+        """
+        dxcc_url = "logbook/qslcards.php"
+        params = {
+            'entity': entity,
+            'ac_acct': ac_acct
+        }
+        # filter down to only used params
+        params = {k: v for k, v in params.items() if v is not None}
+        
+        with self.session as s:
+            response = s.get(self.base_url + dxcc_url, params=params)
+            if response.status_code == 200:
+                # lotw lies, and claims an <eoh> will be absent from bad outputs, but it's there, so we'll do something else.
+                if 'ARRL Logbook of the World DXCC QSL Card Report' not in response.text[:46]:
+                    raise RetrievalFailure(response.text)
+                else:
+                    return Logbook(self.username, response.text)
+            else:
+                response.raise_for_status()
+

qspylib-0.0.1/src/qspylib/qrz.py

@@ -0,0 +1,111 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+import requests
+import html
+import xmltodict
+from qspylib.logbook import Logbook
+
+class QRZInvalidSession(Exception):
+    def __init__(self, message="Got no session key back. This session is invalid."):
+        self.message=message
+        super().__init__(self, message)
+
+
+
+class QRZLogbookAPI:
+    """
+    API wrapper for a QRZ Logbook. At present, only handles fetching QSOs.
+    Fetching returns a Logbook object that must be assigned to something.
+    """
+
+    def __init__(self, key: str):
+        self.key = key
+        self.base_url = "https://logbook.qrz.com/api"
+        self.headers = {
+            'User-Agent': 'pyQSP/0.0.1',
+            'Accept-Encoding': 'gzip, deflate',
+            'Accept': '*/*',
+            'Connection': 'keep-alive'
+        }
+
+    def fetch_logbook(self):
+        params = {
+            'KEY': self.key,
+            'ACTION': 'FETCH',
+            'OPTION': ''
+        }
+        # filter down to only used params
+        params = {k: v for k, v in params.items() if v is not None}
+        
+        response = requests.get(self.base_url, params=params, headers=self.headers)
+        if response.status_code == 200:
+            return QRZLogbookAPI.__stringify(self, response.text)
+        else:
+            response.raise_for_status()
+
+    def insert_record(self, adif, option=None):
+        raise NotImplementedError
+    
+    def delete_record(self, list_logids: list):
+        raise NotImplementedError
+    
+    def check_status(self, list_logids: list):
+        raise NotImplementedError
+    
+
+    
+    ### Helpers
+
+    def __stringify(self, adi_log):
+        qrz_output = html.unescape(adi_log)
+        start_of_log, end_of_log = qrz_output.index('ADIF=') + 5, qrz_output.rindex('<eor>\n\n') + 4
+        log_adi = "<EOH>" + qrz_output[start_of_log:end_of_log] #adif_io expects a header, so we're giving it an end of header
+        return Logbook(self.key, log_adi)
+    
+class QRZXMLInterface:
+    """
+    A wrapper for the QRZ XML interface.
+    This functionality requires being logged in and maintaining a session.
+    """
+
+    def __init__(self, username:str=None, password:str=None):
+        self.username = username,
+        self.password = password,
+        self.agent = 'pyQSP/0.0.1'
+        self.session_key = None
+        self.base_url = "https://xmldata.qrz.com/xml/1.34/"
+        self.headers = {
+            'User-Agent': self.agent,
+            'Accept-Encoding': 'gzip, deflate',
+            'Accept': '*/*',
+            'Connection': 'keep-alive'
+        }
+
+        self.__initiate_session()
+
+    def __initiate_session(self):
+        """Helper -- Grab us a session key so we're not throwing around passwords"""
+        params = {'username': self.username,
+                  'password': self.password,
+                  'agent': self.agent}
+
+        response = requests.get(self.base_url, params=params, headers=self.headers)
+        xml_dict = xmltodict.parse(response.text)
+        key = xml_dict["QRZDatabase"]["Session"].get("Key")
+        if not key:
+            raise QRZInvalidSession()
+        else:
+            self.session_key = key
+
+    def __verify_session(self):
+        """ Helper -- Verify our session key is still valid."""
+        params = {'agent': self.agent,
+                  's': self.session_key}
+
+        response = requests.get(self.base_url, params=params, headers=self.headers)
+        if not xmltodict.parse(response.text)["QRZDatabase"]["Session"].get("Key"):
+            raise QRZInvalidSession()
+
+

qspylib-0.0.1/src/qspylib/test_pytest.py

@@ -0,0 +1,71 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+import pytest
+import qspylib.eqsl as eqsl
+import qspylib.lotw as lotw
+import qspylib.qrz as qrz
+
+##############
+# lotw tests #
+##############
+
+def test_pull_a_call_from_last_upload():
+    last_uploads = lotw.get_last_upload()
+    assert 'W1AW' in last_uploads
+
+def test_bad_login_fetch():
+    with pytest.raises(lotw.RetrievalFailure):
+        lotw_obj = lotw.LOTWSession('**notavalidcall**', '**notarealpassword**')
+        lotw_obj.fetch_logbook()
+
+def test_bad_login_dxcc():
+    with pytest.raises(lotw.RetrievalFailure):
+        lotw_obj = lotw.LOTWSession('**notavalidcall**', '**notarealpassword**')
+        lotw_obj.get_dxcc_credit()
+
+###############
+#  eqsl tests #
+###############
+
+def test_verify_a_bad_eqsl():
+    is_qsl_real, result = eqsl.verify_eqsl('N5UP', 'TEST', '160m', 'SSB', '01/01/2000')
+    assert 'Error - Result: QSO not on file' in result and is_qsl_real is False
+
+def test_verify_a_good_eqsl():
+    is_qsl_real, result = eqsl.verify_eqsl('ai5zk', 'w1tjl', '10m', 'SSB', '01/20/2024')
+    assert 'Result - QSO on file' in result and is_qsl_real is True
+
+def test_pull_a_known_ag_call():
+    callsigns, date = eqsl.get_ag_list()
+    assert 'W1AW' in callsigns
+
+def test_pull_a_known_nonag_call():
+    callsigns, date = eqsl.get_ag_list()
+    assert 'WE3BS' not in callsigns
+
+def test_pull_a_call_from_ag_dated():
+    callsigns, date = eqsl.get_ag_list_dated()
+    assert callsigns.get('W1AW')  >= '0000-00-00'
+
+def test_pull_a_known_call_from_total_members():
+    all_users = eqsl.get_full_member_list()
+    assert all_users.get('W1AW')
+
+def test_pull_a_missing_call_from_total_members():
+    all_users = eqsl.get_full_member_list()
+    assert not all_users.get('WE3BS')
+
+def test_get_user_data():
+    user = eqsl.get_users_data('W1AW')
+    assert user[0] == 'FN31pr' and user[1] == 'Y' and not user[2]
+
+#############
+# qrz tests #
+#############
+
+#def test_qrz_xml_with_invalid_key():
+#    log_obj = qrz.QRZLogbookAPI('aaaaaaaaaaaaa')
+#    log = log_obj.fetch_logbook()
+