# PyHam PE
## Overview
This package provides a client implementation of the AGWPE protocol, enabling
and simplifying the creation of applications using that protocol in order to
communicate with servers such as Direwolf or ldsped.
A lower level API provides access to the protocol at a level close to that of
individual AGWPE frames (not to be confused with AX.25 frames), enabling the
ultimate level of control over communication with the server.
A higher level API provides abstractions helpful in building more complex
applications, transparently taking care of some of the details, such as
connection management and monitoring.
The AGWPE protocol, and thus this package, has the advantage, over other
commonly used protocols such as KISS, that it can be easily used to create
connected-mode sessions. As such, it can be used to create many types of
ham radio software, from simple beaconing to full-fledged packet radio
terminal applications akin to Linpac. (See PyHam's
[Paracon](https://paracon.readthedocs.io/)
software for an example of the latter.)
It is expected that developers working with this package will have some level
of understanding of the AGWPE protocol, though detailed knowledge is *not*
required due to the abstractions provided. Those interested in the details
may wish to refer to the
[AGWPE protocol reference](https://www.on7lds.net/42/sites/default/files/AGWPEAPI.HTM)
in conjunction with the documentation for this package.
**Author**: Martin F N Cooper, KD6YAM
**License**: MIT License
### A note on naming
The protocol on which this package is based is commonly referred to as
AGWPE, and more properly as the AGWPE TCP/IP API. The 'AGWPE' stands
for AGW Packet Engine, where the 'AGW' comes from the callsign of the
original creator of the protocol, George Rossopoulos, SV2AGW. In order to
avoid confusion with software written by SV2AGW and using the name AGWPE,
this PyHam package uses the name PE when referring to the package, and
AGWPE when referring to the protocol.
## Installation
**Important**: This package requires Python 3.7 or later.
The PyHam PE package is distributed on
[PyPI](https://pypi.org/project/pyham_pe/),
and should be installed with pip as follows:
```console
$ pip install pyham_pe
```
Then the modules you require may be imported with the appropriate subset of the
following:
```python
import pe
import pe.app
import pe.connect
import pe.handler
import pe.monitor
```
The source code is available from the
[GitHub repository](https://github.com/mfncooper/pyham_pe):
```console
$ git clone https://github.com/mfncooper/pyham_pe
```
## Documentation
Full documentation is available
[online](https://pyham-pe.readthedocs.io/en/latest/)
and includes the following:
<dl>
<dt><b>User Guide</b></dt>
<dd>The User Guide introduces some conceptual material and then explains the
lower level API and gradually progresses to the simpler, higher level.</dd>
<dt><b>Compatibility</b></dt>
<dd>Some information on the level of support for the protocol that can be
expected from the most popular AGWPE servers.</dd>
<dt><b>API Reference</b></dt>
<dd>If you are looking for information on a specific function, class, or
method, this part of the documentation is for you.</dd>
</dl>
## Discussion
If you have questions about how to use this package, the documentation should
be your first point of reference. If the User Guide, API Reference, or
Compatibility guide don't answer your questions, or you'd simply like to share
your experiences or generally discuss this package, please join the community
on the
[PyHam PE Discussions](https://github.com/mfncooper/pyham_pe/discussions)
forum.
Note that the GitHub Issues tracker should be used only for reporting bugs or
filing feature requests, and should not be used for questions or general
discussion.
## References
<dl>
<dt>AGWPE protocol reference:</dt>
<dd><a href="https://www.on7lds.net/42/sites/default/files/AGWPEAPI.HTM">https://www.on7lds.net/42/sites/default/files/AGWPEAPI.HTM</a></dd>
</dl>
## About PyHam
PyHam is a collection of Python packages targeted at ham radio enthusiasts who
are also software developers. The name was born out of a need to find unique
names for these packages when the most obvious names were already taken.
PyHam packages aim to provide the kind of functionality that makes it much
simpler to build sophisticated ham radio applications without having to start
from scratch. In addition to the packages, PyHam aims to provide useful
real-world ham radio applications for all hams.
See the [PyHam home page](https://pyham.org) for more information, and a
list of currently available libraries and applications.
Raw data
{
"_id": null,
"home_page": null,
"name": "pyham_pe",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "ham radio, amateur radio, packet radio, AGWPE, protocol, connected mode, unproto",
"author": null,
"author_email": "Martin F N Cooper <mfncooper@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/de/e9/67e47ed801978f5203eb95e658dfba1fb205d8a361a929966d78a23bf8a1/pyham_pe-1.1.2.tar.gz",
"platform": null,
"description": "# PyHam PE\n\n## Overview\n\nThis package provides a client implementation of the AGWPE protocol, enabling\nand simplifying the creation of applications using that protocol in order to\ncommunicate with servers such as Direwolf or ldsped.\n\nA lower level API provides access to the protocol at a level close to that of\nindividual AGWPE frames (not to be confused with AX.25 frames), enabling the\nultimate level of control over communication with the server.\n\nA higher level API provides abstractions helpful in building more complex\napplications, transparently taking care of some of the details, such as\nconnection management and monitoring.\n\nThe AGWPE protocol, and thus this package, has the advantage, over other\ncommonly used protocols such as KISS, that it can be easily used to create\nconnected-mode sessions. As such, it can be used to create many types of\nham radio software, from simple beaconing to full-fledged packet radio\nterminal applications akin to Linpac. (See PyHam's\n[Paracon](https://paracon.readthedocs.io/)\nsoftware for an example of the latter.)\n\nIt is expected that developers working with this package will have some level\nof understanding of the AGWPE protocol, though detailed knowledge is *not*\nrequired due to the abstractions provided. Those interested in the details\nmay wish to refer to the\n[AGWPE protocol reference](https://www.on7lds.net/42/sites/default/files/AGWPEAPI.HTM)\nin conjunction with the documentation for this package.\n\n**Author**: Martin F N Cooper, KD6YAM \n**License**: MIT License\n\n### A note on naming\n\nThe protocol on which this package is based is commonly referred to as\nAGWPE, and more properly as the AGWPE TCP/IP API. The 'AGWPE' stands\nfor AGW Packet Engine, where the 'AGW' comes from the callsign of the\noriginal creator of the protocol, George Rossopoulos, SV2AGW. In order to\navoid confusion with software written by SV2AGW and using the name AGWPE,\nthis PyHam package uses the name PE when referring to the package, and\nAGWPE when referring to the protocol.\n\n## Installation\n\n**Important**: This package requires Python 3.7 or later.\n\nThe PyHam PE package is distributed on\n[PyPI](https://pypi.org/project/pyham_pe/),\nand should be installed with pip as follows:\n\n```console\n$ pip install pyham_pe\n```\n\nThen the modules you require may be imported with the appropriate subset of the\nfollowing:\n\n```python\n import pe\n import pe.app\n import pe.connect\n import pe.handler\n import pe.monitor\n```\n\nThe source code is available from the\n[GitHub repository](https://github.com/mfncooper/pyham_pe):\n\n```console\n$ git clone https://github.com/mfncooper/pyham_pe\n```\n\n## Documentation\n\nFull documentation is available\n[online](https://pyham-pe.readthedocs.io/en/latest/)\nand includes the following:\n\n<dl>\n<dt><b>User Guide</b></dt>\n<dd>The User Guide introduces some conceptual material and then explains the\n lower level API and gradually progresses to the simpler, higher level.</dd>\n<dt><b>Compatibility</b></dt>\n<dd>Some information on the level of support for the protocol that can be\n expected from the most popular AGWPE servers.</dd>\n<dt><b>API Reference</b></dt>\n<dd>If you are looking for information on a specific function, class, or\n method, this part of the documentation is for you.</dd>\n</dl>\n\n## Discussion\n\nIf you have questions about how to use this package, the documentation should\nbe your first point of reference. If the User Guide, API Reference, or\nCompatibility guide don't answer your questions, or you'd simply like to share\nyour experiences or generally discuss this package, please join the community\non the\n[PyHam PE Discussions](https://github.com/mfncooper/pyham_pe/discussions)\nforum.\n\nNote that the GitHub Issues tracker should be used only for reporting bugs or\nfiling feature requests, and should not be used for questions or general\ndiscussion.\n\n## References\n\n<dl>\n<dt>AGWPE protocol reference:</dt>\n<dd><a href=\"https://www.on7lds.net/42/sites/default/files/AGWPEAPI.HTM\">https://www.on7lds.net/42/sites/default/files/AGWPEAPI.HTM</a></dd>\n</dl>\n\n## About PyHam\n\nPyHam is a collection of Python packages targeted at ham radio enthusiasts who\nare also software developers. The name was born out of a need to find unique\nnames for these packages when the most obvious names were already taken.\n\nPyHam packages aim to provide the kind of functionality that makes it much\nsimpler to build sophisticated ham radio applications without having to start\nfrom scratch. In addition to the packages, PyHam aims to provide useful\nreal-world ham radio applications for all hams.\n\nSee the [PyHam home page](https://pyham.org) for more information, and a\nlist of currently available libraries and applications.\n",
"bugtrack_url": null,
"license": null,
"summary": "Packet Engine client for the AGWPE protocol",
"version": "1.1.2",
"project_urls": {
"Change Log": "https://github.com/mfncooper/pyham_pe/blob/main/CHANGELOG.md",
"Documentation": "https://pyham-pe.readthedocs.io",
"Source Code": "https://github.com/mfncooper/pyham_pe"
},
"split_keywords": [
"ham radio",
" amateur radio",
" packet radio",
" agwpe",
" protocol",
" connected mode",
" unproto"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "089c1e81543cb2717d80d3b368f0af65bc7b8c14d4431fa90d2d7073f4d5ba10",
"md5": "530f9b8db935c16206a107b4e01ed663",
"sha256": "27c0fbcfcc452b6e7bb2c81592a94e52613761cc85477eacc8f856575a68993b"
},
"downloads": -1,
"filename": "pyham_pe-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "530f9b8db935c16206a107b4e01ed663",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 24994,
"upload_time": "2025-07-20T22:53:13",
"upload_time_iso_8601": "2025-07-20T22:53:13.586510Z",
"url": "https://files.pythonhosted.org/packages/08/9c/1e81543cb2717d80d3b368f0af65bc7b8c14d4431fa90d2d7073f4d5ba10/pyham_pe-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dee967e47ed801978f5203eb95e658dfba1fb205d8a361a929966d78a23bf8a1",
"md5": "c6e9c162feaf36351208d13130372386",
"sha256": "633433b153a03232b87c0729b8441db5654a8b4bd4a715dd9433339a433912f0"
},
"downloads": -1,
"filename": "pyham_pe-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "c6e9c162feaf36351208d13130372386",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 35518,
"upload_time": "2025-07-20T22:53:15",
"upload_time_iso_8601": "2025-07-20T22:53:15.174455Z",
"url": "https://files.pythonhosted.org/packages/de/e9/67e47ed801978f5203eb95e658dfba1fb205d8a361a929966d78a23bf8a1/pyham_pe-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-20 22:53:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mfncooper",
"github_project": "pyham_pe",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "pyham_pe"
}
JSON
