https://github.com/ewpratten/pyrbn

A Python library for consuming data from the Reverse Beacon Network in real time
https://github.com/ewpratten/pyrbn

python-cli python-client reverse-beacon-network

Last synced: 11 months ago
JSON representation

A Python library for consuming data from the Reverse Beacon Network in real time

• Host: GitHub
• URL: https://github.com/ewpratten/pyrbn
• Owner: ewpratten
• License: gpl-3.0
• Created: 2021-01-24T17:39:08.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-24T07:17:02.000Z (about 3 years ago)
• Last Synced: 2025-02-10T02:16:57.466Z (12 months ago)
• Topics: python-cli, python-client, reverse-beacon-network
• Language: Python
• Homepage: https://pypi.org/project/rbn/
• Size: 27.3 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Reverse Beacon Network client for Python ![Poetry Build Suite](https://github.com/Ewpratten/pyRBN/workflows/Poetry%20Build%20Suite/badge.svg)

This is both a library and cli tool, under the package `rbn`

## Installation

pyRBN can be installed from PYPI:

```sh

python3 -m pip install rbn

```

and imported as:

```python

import rbn

```

## CLI Usage

```text

usage: rbn [-h] -c CALLSIGN [-b {630m,160m,80m,60m,40m,30m,20m,17m,15m,12m,10m,6m,4m,2m}] [-m {cw,rtty,psk31,psk63,ft8,ft4}] [-f FILTER_CALL]

CLI frontend to the Reverse Beacon Network

optional arguments:

  -h, --help            show this help message and exit

  -c CALLSIGN, --callsign CALLSIGN

                        Your callsign

  -b {630m,160m,80m,60m,40m,30m,20m,17m,15m,12m,10m,6m,4m,2m}, --band {630m,160m,80m,60m,40m,30m,20m,17m,15m,12m,10m,6m,4m,2m}

                        Band to filter by (this can be passed multiple times)

  -m {cw,rtty,psk31,psk63,ft8,ft4}, --mode {cw,rtty,psk31,psk63,ft8,ft4}

                        Mode to filter by (this can be passed multiple times)

  -f FILTER_CALL, --filter-call FILTER_CALL

                        Callign to filter by (this can be passed multiple times)

```

## Example library usage

The [`__main__.py`](https://github.com/Ewpratten/pyRBN/blob/master/rbn/__main__.py) file is kept fairly simple as an example of using this library.