Merge pull request #274 from miaowware/e-release

Bump version+changelog 2.4.1

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,29 +0,0 @@
----
-name: Bug report
-about: Report a bug to help us improve qrm
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Run command '...' with input '...'
-2. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**System (include if related to running the bot):**
- - OS: [e.g. Linux, Docker]
- - Version: [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for qrm
-title: ''
-labels: enhancement
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

.github/workflows/docker.yml

@@ -1,11 +1,13 @@
-name: Docker Build and Push
+# vim: ts=2 sw=2:
+
+name: Docker Build and Deploy
 
 on:
   push:
     # Publish `master` as Docker `dev` image.
     branches:
       - master
-    # Publish `v*` tags as releases and as `latest`.
+    # Publish `v*` tags as x.x.x images and as `latest`.
     tags:
       - v*
 
@@ -13,46 +15,62 @@ env:
   IMAGE_NAME: qrm2
 
 jobs:
-  build-and-push:
+  docker:
-    runs-on: ubuntu-latest
+    name: Build and push docker images
-
+    runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Write ref to file
+        run: git rev-list -n 1 $GITHUB_REF > ./git_commit
 
       - name: Build image
-        run: |
+        run: docker build . --file Dockerfile -t $IMAGE_NAME
-          echo ${{ github.sha }} > git_commit
-          docker build . --file Dockerfile -t $IMAGE_NAME
 
       - name: Log into Github Package Registry
         run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login docker.pkg.github.com -u ${{ github.actor }} --password-stdin
 
-      - name: Log into Docker Hub
+      - name: Tag image
-        run: echo "${{ secrets.DOCKER_PASSWORD }}" | docker login -u ${{ secrets.DOCKER_USERNAME }} --password-stdin
+        id: tag_image
-
-      - name: Push image to registries
         run: |
-          GITHUB_IMAGE_ID=docker.pkg.github.com/${{ github.repository }}/$IMAGE_NAME
+          IMAGE_ID=docker.pkg.github.com/${{ github.repository }}/$IMAGE_NAME
-          DOCKER_IMAGE_ID=${{ secrets.DOCKER_USERNAME }}/$IMAGE_NAME
+          echo IMAGE_ID=$IMAGE_ID
+          echo ::set-output name=image_id::$IMAGE_ID
 
           # Strip git ref prefix from version
           VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
-
           # Strip "v" prefix from tag name
           [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
-
+          # if version is master, set version to dev
           [[ "$VERSION" == "master" ]] && VERSION=dev
-
-          echo GITHUB_IMAGE_ID=$GITHUB_IMAGE_ID
-          echo DOCKER_IMAGE_ID=$DOCKER_IMAGE_ID
           echo VERSION=$VERSION
+          echo ::set-output name=version::$VERSION
 
-          # tag for Github Registry
+          # tag dev or x.x.x
-          docker tag $IMAGE_NAME $GITHUB_IMAGE_ID:$VERSION
+          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
-          [[ "$VERSION" != "dev" ]] && docker tag $IMAGE_NAME $GITHUB_IMAGE_ID:latest
+          # tag latest if not a dev release
-          docker push $GITHUB_IMAGE_ID
+          [[ "$VERSION" != "dev" ]] && docker tag $IMAGE_NAME $IMAGE_ID:latest || true
 
-          # tag for Docker Hub
+      - name: Push images to registry
-          docker tag $IMAGE_NAME $DOCKER_IMAGE_ID:$VERSION
+        run: docker push ${{ steps.tag_image.outputs.image_id }}
-          [[ "$VERSION" != "dev" ]] && docker tag $IMAGE_NAME $DOCKER_IMAGE_ID:latest
+
-          docker push $DOCKER_IMAGE_ID
+#  deploy:
+#    name: Deploy new images
+#    runs-on: ubuntu-20.04
+#    needs: docker
+#    steps:
+#      - name: Deploy official images
+#        id: deploy_images
+#        uses: satak/webrequest-action@v1.2.3
+#        with:
+#          url: ${{ secrets.DEPLOY_URL }}
+#          method: POST
+#          headers: '{"Authentication": "Token ${{ secrets.DEPLOY_TOKEN }}"}'
+#          payload: |
+#            '{
+#              "repository": "${{ github.repository }}",
+#              "version": "${{ jobs.docker.steps.tag_image.outputs.version }}"
+#             }'

.github/workflows/linting.yml

@@ -1,6 +1,6 @@
 name: Linting
 
-on: [push]
+on: [push,pull_request]
 
 jobs:
   flake8_py3:

.github/workflows/release.yml

@@ -0,0 +1,58 @@
+# vim: ts=2 sw=2:
+
+on:
+  push:
+    # Sequence of patterns matched against refs/tags
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+
+name: Create Release
+
+jobs:
+  release:
+    name: Create Release
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Get Version Info
+        id: get_tag
+        shell: bash
+        run: |
+          SUBJECT=$(/usr/bin/git tag -l ${GITHUB_REF#refs/tags/} --format='%(subject)')
+          BODY=$(/usr/bin/git tag -l ${GITHUB_REF#refs/tags/} --format='%(body)' | sed '/-----BEGIN PGP SIGNATURE-----/,$d')
+
+          echo SUBJECT=$SUBJECT
+          echo BODY=$BODY
+
+          echo ::set-output name=subject::${SUBJECT}
+          echo ::set-output name=body::${BODY}
+          echo ::set-output name=current_version::${GITHUB_REF#refs/tags/v}
+
+      - name: Get Changelog Content
+        id: changelog_reader
+        uses: mindsers/changelog-reader-action@v2
+        with:
+          version: ${{ steps.get_tag.outputs.current_version }}
+          path: ./CHANGELOG.md
+
+      - name: Publish Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.changelog_reader.outputs.version }}
+          release_name: ${{ steps.get_tag.outputs.subject }}
+          body: |
+            ${{ steps.get_tag.outputs.body }}
+
+            ## Changelog
+
+            ${{ steps.changelog_reader.outputs.changes }}
+          draft: false
+          prerelease: false
+

.gitignore

@@ -9,6 +9,8 @@ cty.zip
 
 /docker-compose.yml
 
+.vscode/
+
 
 #########################################################
 # Byte-compiled / optimized / DLL files

CHANGELOG.md

@@ -7,6 +7,30 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## [Unreleased]
 
 
+## [2.4.1] - 2020-10-06
+### Changed
+- Bumped discord.py to 1.5.0
+
+
+## [2.4.0] - 2020-09-27
+### Added
+- Canadian prefix info to the `?prefixes` command.
+- `?worksplit` command.
+- Maps for CQ Zones, ITU Zones, ITU Regions, and Canadian prefixes.
+- Attribution for all maps.
+- Option to append ` | ?help` to the playing status.
+- `?dbconv` command to convert voltage, power, and antenna gain values.
+### Changed
+- ARRL/RAC section maps to include all current ARRL/RAC sections.
+### Fixed
+- Issue where multiple prefixes were not handled properly.
+
+
+## [2.3.2] - 2020-07-22
+### Fixed
+- Dependency issues
+
+
 ## [2.3.1] - 2020-04-02
 ### Fixed
 - Wordlist containing innappropriate words.
@@ -105,7 +129,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## 1.0.0 - 2019-07-31 [YANKED]
 
 
-[Unreleased]: https://github.com/miaowware/qrm2/compare/v2.3.1...HEAD
+[Unreleased]: https://github.com/miaowware/qrm2/compare/v2.4.1...HEAD
+[2.4.1]: https://github.com/miaowware/qrm2/releases/tag/v2.4.1
+[2.4.0]: https://github.com/miaowware/qrm2/releases/tag/v2.4.0
+[2.3.2]: https://github.com/miaowware/qrm2/releases/tag/v2.3.2
 [2.3.1]: https://github.com/miaowware/qrm2/releases/tag/v2.3.1
 [2.3.0]: https://github.com/miaowware/qrm2/releases/tag/v2.3.0
 [2.2.3]: https://github.com/miaowware/qrm2/releases/tag/v2.2.3

DEVELOPING.md

@@ -0,0 +1,54 @@
+# Development Guide for qrm
+
+**Make sure to also read [`CONTRIBUTING.md`][0], everything in there applies here.**
+
+### Environment Setup
+
+1. [Fork this repo][1] into your own GitHub namespace.
+1. Make sure the `master` branch is up to date, then make yourself a new branch with a descriptive name.
+1. Once the forked repo is cloned and on the proper branch, you can set up the development environment.
+    1. Install python 3.7 or higher.
+    1. Run `make dev-install`.
+       This should install everything you need to develop and run qrm.
+    1. [Create a bot and token][2], and add it to `data/keys.py`.
+       Also add your [QRZ credentials][3] if needed.
+    1. In `data/options.py`, change values as needed.
+       Some commands require adding your Discord user ID to `owner_uids`.
+    1. To activate the virtual env that was created by `make`, run `source botenv/bin/activate` (or the equivelent for your shell or operating system).
+
+These instructions are fairly \*NIX-centric, so if you would like to develop on Windows, it is suggested that the Windows Subsystem for Linux be used.
+
+## While You Develop
+
+To run qrm, use the command `./run.sh`.
+We recommend you use the `--pass-errors` flag to avoid perpetual restart loops if you break the bot.
+It exists because repeatedly mashing [Ctrl+C] at high speed to break a fast loop is not fun.
+
+Make sure to add [type hints][4] to your code.
+This is what `mypy` validates in the code.
+
+Using `dev-notes` for documentation is especially important if you introduce a new json file format (like for maps and bandplans) or to document some development process (like the command to crush the various images in the repository).
+
+### Test your changes
+
+In addition to testing functionality, make sure to run `flake8` to ensure your code uses the proper style, and `mypy [files...]` to ensure proper typing.
+You can also enable them for this project in your IDE if supported.
+This will give you automatic and continuous linting and type checking.
+
+### A Note on Style
+
+qrm tries to keep to PEP 8 style whenever possible.
+Use the utility `flake8` to check that you follow this style.
+When you start a PR or push commits, GitHub will automatically run this for you,
+but we prefer that developers check this before committing and opening PRs.
+
+Otherwise, try to follow the existing style:
+- double-quotes except when required to be single,
+- indentation of mult-line structures matching other examples in the code,
+- etc.
+
+[0]: https://github.com/miaowware/.github/blob/master/CONTRIBUTING.md
+[1]: https://github.com/miaowware/qrm2/fork
+[2]: https://discordpy.readthedocs.io/en/latest/discord.html
+[3]: https://www.qrz.com/page/xml_data.html
+[4]: https://docs.python.org/3/library/typing.html

Makefile

@@ -71,6 +71,17 @@ clean:
 
 
 ### Dev targets ###
+.PHONY: dev-install
+dev-install: $(BOTENV)/dev_req_done data/options.py data/keys.py
+
+# Installing dev requirements
+$(BOTENV)/dev_req_done: dev-requirements.txt $(BOTENV)/success
+	@echo "\033[34;1m--> Installing the dependencies...\033[0m"
+	@. $(BOTENV)/bin/activate; \
+		pip install ${PIP_OUTPUT} -U pip setuptools wheel; \
+		pip install ${PIP_OUTPUT} -U -r dev-requirements.txt
+	@touch $(BOTENV)/dev_req_done
+
 
 
 ### Special targets ###

README-DOCKER.md

@@ -1,6 +1,6 @@
 # Docker help for qrm2
 
-You have multiple ways to use docker to run an instance of qrm2
+You have multiple ways to use docker to run an instance of qrm2.
 
 - [Docker help for qrm2](#docker-help-for-qrm2)
   - [Using docker-compose and the prebuilt-image (recommended)](#using-docker-compose-and-the-prebuilt-image-recommended)
@@ -23,13 +23,14 @@ This is the easiest method for running the bot without any modifications.
     version: '3'
     services:
       qrm2:
-        image: "classabbyamp/discord-qrm2:latest"
+        image: "docker.pkg.github.com/miaowware/qrm2/qrm2:latest"
         restart: on-failure
         volumes:
           - "./data:/app/data:rw"
         environment:
           - PYTHONUNBUFFERED=1
     ```
+   *Note that Github's registry requires [a few extra steps](https://docs.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages) during the initial setup.*
 
 3. Create a subdirectory named `data`.
 
@@ -42,7 +43,7 @@ This is the easiest method for running the bot without any modifications.
     $ docker-compose up -d
     ```
 
-    > Run without "-d" to test the bot. (run in foreground)
+    *Run without "-d" to test the bot (run in foreground).*
 
 
 
@@ -59,7 +60,7 @@ This is the easiest method to run the bot with modifications.
     services:
       qrm2:
         build: .
-        image: "discord-qrm2:local-latest"
+        image: "qrm2:local-latest"
         restart: on-failure
         volumes:
           - "./data:/app/data:rw"
@@ -75,10 +76,10 @@ This is the easiest method to run the bot with modifications.
 
     ```none
     $ docker-compose build --pull
-    $ docker-compose -d
+    $ docker-compose up -d
     ```
 
-    > Run without "-d" to test the bot. (run in foreground)
+    *Run without "-d" to test the bot (run in foreground).*
 
 
 
@@ -95,7 +96,7 @@ This methods is not very nice to use.
 2. Run docker build:
 
     ```none
-    $ docker build -t discord-qrm2:local-latest .
+    $ docker build -t qrm2:local-latest .
     ```
 
 
@@ -110,5 +111,5 @@ This methods is not very nice to use.
     ```
 
     Where `[image]` is either of:
-    - `discord-qrm2:local-latest` if you are building your own.
+    - `qrm2:local-latest` if you are building your own.
-    - `classabbyamp/discord-qrm2:latest` if you want to use the prebuilt image.
+    - `docker.pkg.github.com/miaowware/qrm2/qrm2:latest` if you want to use the prebuilt image.

README.md

@@ -28,6 +28,10 @@ Run. For more information on options, see the [quick-bot-no-pain run.sh document
 $ run.sh
 ```
 
+## Contributing
+
+Check out the [contribution guidelines](/CONTRIBUTING.md) for more information about how to contribute to this project.
+
 ## Copyright
 
 Copyright (C) 2019-2020 Abigail Gold, 0x5c

common.py

@@ -63,6 +63,7 @@ emojis = SimpleNamespace(
 paths = SimpleNamespace(
     data=Path("./data/"),
     resources=Path("./resources/"),
+    img=Path("./resources/img/"),
     bandcharts=Path("./resources/img/bandcharts/"),
     maps=Path("./resources/img/maps/"),
 )
@@ -70,6 +71,16 @@ paths = SimpleNamespace(
 
 # --- Classes ---
 
+
+class CallsignInfoData:
+    """Represents a country's callsign info"""
+    def __init__(self, data: list):
+        self.title: str = data[0]
+        self.desc: str = data[1]
+        self.calls: str = data[2]
+        self.emoji: str = data[3]
+
+
 class ImageMetadata:
     """Represents the metadata of a single image."""
     def __init__(self, metadata: list):

dev-notes/image-processing.md

@@ -0,0 +1,4 @@
+# Image processing instructions
+
+For images like bandplans and maps, first resize the image to a reasonable size, then run `pngquant --quality 30-40` on the images.
+Do not apply that to non-flat images like actual pictures.

dev-notes/metadata-format.md

@@ -20,5 +20,5 @@ Used for grouping info such as name, description, source, and such.
 | `name`        | The name of the file.                           | `Canada`, `ITU Zones`                            |
 | `long_name`   | The long name (title) of the file.              | `Worldwide map of ITU Zones`                     |
 | `description` | The description accompanying the file.          | `Full radio allocations chart for all services.` |
-| `source`      | The source of the file.                         | `Instituto Federal de Telecomunicaciones (IFT)` |
+| `source`      | The source of the file.                         | `Instituto Federal de Telecomunicaciones (IFT)`  |
 | `emoji`       | A Unicode emoji associated with the file.       | `📻`, `🇨🇦`                                       |

dev-requirements.txt

@@ -0,0 +1,3 @@
+-r requirements.txt
+flake8
+discord.py-stubs==1.5.0

exts/base.py

@@ -46,9 +46,9 @@ class QrmHelpCommand(commands.HelpCommand):
             if parent:
                 fmt = f"{parent} {fmt}"
             alias = fmt
-            return f"{opt.prefix}{alias} {command.signature}\n    *Aliases:* {aliases}"
+            return f"{opt.display_prefix}{alias} {command.signature}\n    *Aliases:* {aliases}"
         alias = command.name if not parent else f"{parent} {command.name}"
-        return f"{opt.prefix}{alias} {command.signature}"
+        return f"{opt.display_prefix}{alias} {command.signature}"
 
     async def send_error_message(self, error):
         embed = cmn.embed_factory(self.context)
@@ -60,7 +60,7 @@ class QrmHelpCommand(commands.HelpCommand):
     async def send_bot_help(self, mapping):
         embed = cmn.embed_factory(self.context)
         embed.title = "qrm Help"
-        embed.description = (f"For command-specific help and usage, use `{opt.prefix}help [command name]`."
+        embed.description = (f"For command-specific help and usage, use `{opt.display_prefix}help [command name]`."
                              " Many commands have shorter aliases.")
         mapping = await mapping
 

exts/dbconv.py

@@ -0,0 +1,201 @@
+"""
+Conversion extension for qrm
+---
+Copyright (C) 2020 Abigail Gold, 0x5c
+
+This file is part of qrm2 and is released under the terms of
+the GNU General Public License, version 2.
+"""
+
+
+import math
+from enum import Enum
+from typing import Optional
+
+import discord.ext.commands as commands
+
+import common as cmn
+from data import options as opt
+
+
+# not sure why but UnitConverter and Unit need to be defined before DbConvCog and convert()
+class UnitConverter(commands.Converter):
+    async def convert(self, ctx: commands.Context, argument: str):
+        try:
+            return Unit(argument)
+        except ValueError as e:
+            raise commands.BadArgument(message=str(e))
+
+
+class Unit:
+    def __init__(self, raw: str):
+        self.raw: str = raw
+        self.unit: str
+        self.type: UnitType
+        self.is_db: bool
+        self.mult: int
+        self._parse()
+
+    def _parse(self):
+        s = self.raw.lower()
+        if len(s) > 2 and s[:2] == "db":
+            self.is_db = True
+            if s[2:] in units:
+                u = units[s[2:]]
+                self.mult = u["mult"]
+                self.unit = u["log"]
+                self.type = u["type"]
+        elif s in units:
+            self.is_db = False
+            u = units[s]
+            self.mult = u["mult"]
+            self.unit = u["scalar"]
+            self.type = u["type"]
+        else:
+            raise ValueError(f"Invalid unit: {self.raw}")
+
+    def __str__(self):
+        return self.unit
+
+
+class UnitType(Enum):
+    voltage = 1
+    power = 2
+    antenna = 3
+
+
+class DbConvCog(commands.Cog):
+    def __init__(self, bot: commands.Bot):
+        self.bot = bot
+
+    @commands.command(name="dbconv", aliases=["dbc"], category=cmn.cat.ref)
+    async def _db_conv(self, ctx: commands.Context,
+                       value: Optional[float] = None,
+                       unit_from: Optional[UnitConverter] = None,
+                       unit_to: Optional[UnitConverter] = None):
+        """
+        Convert between decibels and scalar values for voltage, power, and antenna gain.
+
+        **Valid Units**
+        *Voltage:* V, mV, µV, uV, dBV, dBmV, dBµV, dBuV
+        *Power:* fW, mW, W, kW, dBf, dBm, dBW, dBk
+        *Antenna Gain:* dBi, dBd, dBq
+        """
+        embed = cmn.embed_factory(ctx)
+        if value is not None and unit_from is not None and unit_to is not None:
+            converted = convert(value, unit_from, unit_to)
+
+            embed.title = f"{value:.3g} {unit_from} = {converted:.3g} {unit_to}"
+            embed.colour = cmn.colours.good
+        else:
+            embed.title = "Decibel Quick Reference"
+            embed.description = (
+                "Decibels are a great way to easily represent large quantities that are common in electronics. "
+                "There are a few main types that are used often in radio: voltage, power, and antenna gain. "
+                "Here are some commonly-used reference levels for each type:"
+            )
+            v_db_info = ("**dBV** = relative to 1 V\n"
+                         "**dBmV** = relative to 1 mV (1e-3 V)\n"
+                         "**dBµV** = relative to 1 µV (1e-6 V)")
+            embed.add_field(name="Voltage Decibels", value=v_db_info, inline=False)
+            p_db_info = ("**dBW** = relative to 1 W\n"
+                         "**dBk** = relative to 1 kW (1e3 W)\n"
+                         "**dBm** = relative to 1 mW (1e-3 W)\n"
+                         "**dBf** = relative to 1 fW (1e-15 W)")
+            embed.add_field(name="Power Decibels", value=p_db_info, inline=False)
+            a_db_info = ("**dBi** = relative to a theoretical __i__sotropic radiator in free space "
+                         "(equal radiation in all directions)\n"
+                         "**dBd** = relative to a dipole in free space (0 dBd = 2.15 dBi)\n"
+                         "**dBq** = relative to a quarter-wave antenna in free space (0 dBq = -0.85 dBi)")
+            embed.add_field(name="Antenna Gain Decibels", value=a_db_info, inline=False)
+            embed.add_field(name="Use the bot to do the conversions",
+                            value=f"`{opt.display_prefix}dbconv [value] [unit_from] [unit_to]`",
+                            inline=False)
+        await ctx.send(embed=embed)
+
+
+def setup(bot: commands.Bot):
+    bot.add_cog(DbConvCog(bot))
+
+
+def convert(initial: float, unit1: Unit, unit2: Unit):
+    if unit1.type == unit2.type:
+        # dB to dB
+        if unit1.is_db and unit2.is_db:
+            if unit1.mult == unit2.mult:
+                return initial
+            elif unit1.type == UnitType.voltage:
+                return _calc_volt_db(_calc_volt(initial, unit1.mult), unit2.mult)
+            elif unit1.type == UnitType.power:
+                return _calc_power_db(_calc_power(initial, unit1.mult), unit2.mult)
+            elif unit1.type == UnitType.antenna:
+                return initial + (unit1.mult - unit2.mult)
+        # V/W to V/W
+        elif not unit1.is_db and not unit2.is_db:
+            if unit1.mult == unit2.mult:
+                return initial
+            return initial * unit1.mult / unit2.mult
+        # dB to V/W
+        elif unit1.is_db and not unit2.is_db:
+            if unit1.type == UnitType.voltage:
+                return _calc_volt(initial, unit1.mult) / unit2.mult
+            elif unit1.type == UnitType.power:
+                return _calc_power(initial, unit1.mult) / unit2.mult
+        # V/W to dB
+        elif not unit1.is_db and unit2.is_db:
+            if unit1.type == UnitType.voltage:
+                return _calc_volt_db(initial * unit1.mult, unit2.mult)
+            elif unit1.type == UnitType.power:
+                return _calc_power_db(initial * unit1.mult, unit2.mult)
+    raise ValueError(f"Can't convert between {unit1} and {unit2}")
+
+
+units = {
+    # voltage
+    "uv": {"mult": 1e-6,  "scalar": "µV", "log": "dBµV", "type": UnitType.voltage},
+    "µv": {"mult": 1e-6,  "scalar": "µV", "log": "dBµV", "type": UnitType.voltage},
+    "mv": {"mult": 1e-3,  "scalar": "mV", "log": "dBmV", "type": UnitType.voltage},
+    "v":  {"mult": 1,     "scalar":  "V", "log":  "dBV", "type": UnitType.voltage},
+    # power
+    "fw": {"mult": 1e-15, "scalar": "fW", "log":  "dBf", "type": UnitType.power},
+    "f":  {"mult": 1e-15, "scalar": "fW", "log":  "dBf", "type": UnitType.power},
+    "mw": {"mult": 1e-3,  "scalar": "mW", "log":  "dBm", "type": UnitType.power},
+    "m":  {"mult": 1e-3,  "scalar": "mW", "log":  "dBm", "type": UnitType.power},
+    "w":  {"mult": 1,     "scalar":  "W", "log":  "dBW", "type": UnitType.power},
+    "kw": {"mult": 1e3,   "scalar": "kW", "log":  "dBk", "type": UnitType.power},
+    "k":  {"mult": 1e3,   "scalar": "kW", "log":  "dBk", "type": UnitType.power},
+    # antenna
+    "q":  {"mult": -0.85, "scalar": None, "log":  "dBq", "type": UnitType.antenna},
+    "i":  {"mult": 0,     "scalar": None, "log":  "dBi", "type": UnitType.antenna},
+    "d":  {"mult": 2.15,  "scalar": None, "log":  "dBd", "type": UnitType.antenna},
+}
+
+
+def _calc_power_db(p: float, ref: float):
+    return 10 * math.log10(p / ref)
+
+
+def _calc_power(db: float, ref: float):
+    return 10 ** (db / 10) * ref
+
+
+def _calc_volt_db(v: float, ref: float):
+    return 20 * math.log10(v / ref)
+
+
+def _calc_volt(db: float, ref: float):
+    return 10 ** (db / 20) * ref
+
+
+# testing code
+if __name__ == "__main__":
+    while(True):
+        try:
+            ip = input("> ").split()
+            initial = float(ip[0])
+            unit1 = Unit(ip[1])
+            unit2 = Unit(ip[2])
+            conv = convert(initial, unit1, unit2)
+            print(f"{initial:.2f} {unit1} = {conv:.2f} {unit2}")
+        except ValueError as e:
+            print(e)

exts/fun.py

@@ -10,6 +10,7 @@ the GNU General Public License, version 2.
 
 import random
 
+import discord
 import discord.ext.commands as commands
 
 import common as cmn
@@ -36,6 +37,16 @@ class FunCog(commands.Cog):
         """Returns xkcd: Standards."""
         await ctx.send("http://xkcd.com/927")
 
+    @commands.command(name="worksplit", aliases=["split", "ft8"], category=cmn.cat.fun)
+    async def _worksplit(self, ctx: commands.Context):
+        """Posts "Work split you lids"."""
+        fn = "worksplit.jpg"
+        embed = cmn.embed_factory(ctx)
+        embed.title = "Work Split, You Lids!"
+        embed.set_image(url="attachment://" + fn)
+        img = discord.File(cmn.paths.img / fn, filename=fn)
+        await ctx.send(embed=embed, file=img)
+
     @commands.command(name="xd", hidden=True, category=cmn.cat.fun)
     async def _xd(self, ctx: commands.Context):
         """ecks dee"""

exts/ham.py

@@ -21,6 +21,7 @@ from resources import qcodes
 class HamCog(commands.Cog):
     def __init__(self, bot: commands.Bot):
         self.bot = bot
+        self.pfxs = callsign_info.options
 
     @commands.command(name="qcode", aliases=["q"], category=cmn.cat.ref)
     async def _qcode_lookup(self, ctx: commands.Context, qcode: str):
@@ -64,22 +65,26 @@ class HamCog(commands.Cog):
         await ctx.send(embed=embed)
 
     @commands.command(name="prefixes", aliases=["vanity", "pfx", "vanities", "prefix"], category=cmn.cat.ref)
-    async def _vanity_prefixes(self, ctx: commands.Context, country: str = None):
+    async def _vanity_prefixes(self, ctx: commands.Context, country: str = ""):
         """Lists valid callsign prefixes for different countries."""
-        if country is None:
+        country = country.lower()
-            await ctx.send_help(ctx.command)
-            return
         embed = cmn.embed_factory(ctx)
-        if country.lower() not in callsign_info.options:
+        if country not in self.pfxs:
-            embed.title = f"{country} not found!"
+            desc = "Possible arguments are:\n"
-            embed.description = f"Valid countries: {', '.join(callsign_info.options.keys())}"
+            for key, val in self.pfxs.items():
+                desc += f"`{key}`: {val.title}{('  ' + val.emoji if val.emoji else '')}\n"
+            embed.title = f"{country} Not Found!"
+            embed.description = desc
             embed.colour = cmn.colours.bad
+            await ctx.send(embed=embed)
+            return
         else:
-            embed.title = callsign_info.options[country.lower()][0]
+            data = self.pfxs[country]
-            embed.description = callsign_info.options[country.lower()][1]
+            embed.title = data.title + ("  " + data.emoji if data.emoji else "")
+            embed.description = data.desc
             embed.colour = cmn.colours.good
 
-            for name, val in callsign_info.options[country.lower()][2].items():
+            for name, val in data.calls.items():
                 embed.add_field(name=name, value=val, inline=False)
         await ctx.send(embed=embed)
 

info.py

@@ -12,5 +12,5 @@ authors = ("@ClassAbbyAmplifier#2229", "@0x5c#0639")
 description = """A bot with various useful ham radio-related functions, written in Python."""
 license = "Released under the GNU General Public License v2"
 contributing = "Check out the source on GitHub, contributions welcome: https://github.com/miaowware/qrm2"
-release = "2.3.1"
+release = "2.4.1"
 bot_server = "https://discord.gg/Ntbg3J4"

main.py

@@ -44,9 +44,21 @@ debug_mode = opt.debug  # Separate assignement in-case we define an override (te
 loop = asyncio.get_event_loop()
 connector = loop.run_until_complete(conn.new_connector())
 
+# Defining the intents
+intents = discord.Intents.default()
+# We don't need those
+intents.bans = False
+intents.emojis = False
+intents.integrations = False
+intents.webhooks = False
+intents.invites = False
+intents.voice_states = False
+intents.typing = False
+
 bot = commands.Bot(command_prefix=opt.prefix,
                    case_insensitive=True,
                    description=info.description, help_command=commands.MinimalHelpCommand(),
+                   intents=intents,
                    loop=loop,
                    connector=connector)
 
@@ -193,7 +205,10 @@ async def _ensure_activity_time():
     try:
         tz = pytz.timezone(opt.status_tz)
     except pytz.exceptions.UnknownTimeZoneError:
-        await bot.change_presence(activity=discord.Game(name="with invalid timezones."))
+        status = "with invalid timezones"
+        if opt.show_help:
+            status += f" | {opt.display_prefix}help"
+        await bot.change_presence(activity=discord.Game(name=status))
         return
 
     now = datetime.now(tz=tz).time()
@@ -203,6 +218,8 @@ async def _ensure_activity_time():
         end_time = time(hour=sts[2][0], minute=sts[2][1], tzinfo=tz)
         if start_time < now <= end_time:
             status = sts[0]
+            if opt.show_help:
+                status += f" | {opt.display_prefix}help"
 
     await bot.change_presence(activity=discord.Game(name=status))
 
@@ -210,6 +227,8 @@ async def _ensure_activity_time():
 @tasks.loop(minutes=5)
 async def _ensure_activity_random():
     status = random.choice(opt.statuses)
+    if opt.show_help:
+        status += f" | {opt.display_prefix}help"
 
     await bot.change_presence(activity=discord.Game(name=status))
 
@@ -217,6 +236,8 @@ async def _ensure_activity_random():
 @tasks.loop(minutes=5)
 async def _ensure_activity_fixed():
     status = opt.statuses[0]
+    if opt.show_help:
+        status += f" | {opt.display_prefix}help"
 
     await bot.change_presence(activity=discord.Game(name=status))
 

requirements.txt

@@ -1,5 +1,5 @@
-discord.py
+discord.py==1.5.0
-ctyparser
+ctyparser==2.0.0.post1
-beautifulsoup4
+beautifulsoup4==4.9.1
-lxml
+lxml==4.5.2
-pytz
+pytz==2020.1

resources/callsign_info.py

@@ -1,5 +1,5 @@
 """
-Information about callsigns for the vanity prefixes command in hamcog.
+Information about callsigns for the prefixes command in hamcog.
 ---
 Copyright (C) 2019-2020 Abigail Gold, 0x5c
 
@@ -7,49 +7,12 @@ This file is part of discord-qrmbot and is released under the terms of
 the GNU General Public License, version 2.
 """
 
+from .callsigninfos import (us, ca)
+from common import CallsignInfoData
 
-us_calls_title = "Valid US Vanity Callsigns"
-us_calls_desc = ("#x# is the number of letters in the prefix and suffix of a callsign. "
-                 "E.g., WY4RC would be a 2x2 callsign, with prefix WY and suffix RC.")
-us_calls = {
-                "**Group A** (Extra Only)": ("**Any:** K, N, W (1x2)\n"
-                                             "    AA-AL, KA-KZ, NA-NZ, WA-WZ (2x1)\n"
-                                             "    AA-AL (2x2)\n"
-                                             "*Except*\n"
-                                             "**Alaska:** AL, KL, NL, WL (2x1)\n"
-                                             "**Caribbean:** KP, NP, WP (2x1)\n"
-                                             "**Pacific:** AH, KH, NH, WH (2x1)"),
-                "**Group B** (Advanced and Extra Only)": ("**Any:** KA-KZ, NA-NZ, WA-WZ (2x2)\n"
-                                                          "*Except*\n"
-                                                          "**Alaska:** AL (2x2)\n"
-                                                          "**Caribbean:** KP (2x2)\n"
-                                                          "**Pacific:** AH (2x2)"),
-                "**Group C** (Technician, General, Advanced, Extra Only)": ("**Any Region:** K, N, W (1x3)\n"
-                                                                            "*Except*\n"
-                                                                            "**Alaska:** KL, NL, WL (2x2)\n"
-                                                                            "**Caribbean:** NP, WP (2x2)\n"
-                                                                            "**Pacific:** KH, NH, WH (2x2)"),
-                "**Group D** (Any License Class)": ("**Any Region:** KA-KZ, WA-WZ (2x3)\n"
-                                                    "*Except*\n"
-                                                    "**Alaska:** KL, WL (2x3)\n"
-                                                    "**Caribbean:** KP, WP (2x3)\n"
-                                                    "**Pacific:** KH, WH (2x3)"),
-                "**Unavailable**": ("- KA2AA-KA9ZZ: US Army in Japan\n"
-                                    "- KC4AAA-KC4AAF: NSF in Antartica\n"
-                                    "- KC4USA-KC4USZ: US Navy in Antartica\n"
-                                    "- KG4AA-KG4ZZ: US Navy in Guantanamo Bay\n"
-                                    "- KL9KAA-KL9KHZ: US military in Korea\n"
-                                    "- KC6AA-KC6ZZ: Former US (Eastern and Western Caroline Islands), "
-                                    "now Federated States of Micronesia (V6) and Republic of Palau (T8)\n"
-                                    "- KX6AA-KX6ZZ: Former US (Marshall Islands), "
-                                    "now Republic of the Marshall Islands (V73)\n"
-                                    "- Any suffix SOS or QRA-QUZ\n"
-                                    "- Any 2x3 with X as the first suffix letter\n"
-                                    "- Any 2x3 with AF, KF, NF, or WF prefix and suffix EMA: FEMA\n"
-                                    "- Any 2x3 with AA-AL, NA-NZ, WC, WK, WM, WR, or WT prefix: \"Group X\"\n"
-                                    "- Any 2x1, 2x2, or 2x3 with KP, NP, WP prefix and 0, 6, 7, 8, 9 number\n"
-                                    "- Any 1x1 callsign: Special Event")
-           }
 
 # format: country: (title, description, text)
-options = {"us": (us_calls_title, us_calls_desc, us_calls)}
+options = {
+    "us": CallsignInfoData([us.title, us.desc, us.calls, us.emoji]),
+    "ca": CallsignInfoData([ca.title, ca.desc, ca.calls, ca.emoji]),
+}

resources/callsigninfos/__init__.py

@@ -0,0 +1,3 @@
+"""
+Callsign info for various countries
+"""

resources/callsigninfos/ca.py

@@ -0,0 +1,47 @@
+"""
+Information about callsigns for the CA prefixes command in hamcog.
+---
+Copyright (C) 2019-2020 Abigail Gold, 0x5c
+
+This file is part of discord-qrmbot and is released under the terms of
+the GNU General Public License, version 2.
+"""
+
+
+title = "Canadian Callsign Rules"
+emoji = "🇨🇦"
+desc = ("Canadian operators are limited to callsigns with the prefixes of their address' province/territory. "
+        "Initially, operators can choose a callsign with a 3-letter suffix. "
+        "Later on, they can apply to change or for additional callsigns. "
+        "Operators can only hold one 2-letter suffix callsign, but many 3-letter suffix callsigns. "
+        "If the number of 2-letter suffix callsigns exceeds 80% of the total available, "
+        "operators can only choose a 2-letter suffix after holding a license for 5 years. "
+        "If the operator is a family member of a deceased operator, they are not bound by this restriction. "
+        "Data from [ISED Canada (RIC-9)](https://www.ic.gc.ca/eic/site/smt-gst.nsf/eng/sf02102.html).")
+calls = {
+    "Provinces": (
+        "**Nova Scotia:** VE1 and VA1\n"
+        "**Québec:** VE2 and VA2\n"
+        "**Ontario:** VE3 and VA3\n"
+        "**Manitoba:** VE4 and VA4\n"
+        "**Saskatchewan:** VE5 and VA5\n"
+        "**Alberta:** VE6 and VA6\n"
+        "**British Columbia:** VE7 and VA7\n"
+        "**New Brunswick:** VE9\n"
+        "**Newfoundland:** VO1\n"
+        "**Labrador:** VO2\n"
+        "**Prince Edward Island:** VY2\n"
+    ),
+    "Territories": (
+        "**Northwest Territories:** VE8\n"
+        "**Nunavut:** VY0\n"
+        "**Yukon:** VY1\n"
+    ),
+    "Other": (
+        "**International Waters:** VE0\n"
+        "**Government of Canada:** VY9\n"
+        "**Sable Island:** CY0\n"
+        "**St-Paul Island:** CY9\n"
+    ),
+    "Special Event": "Various prefixes in the ranges: CF-CK, CY-CZ, VA-VG, VO, VX-VY, XJ-XO"
+}

resources/callsigninfos/us.py

@@ -0,0 +1,53 @@
+"""
+Information about callsigns for the US prefixes command in hamcog.
+---
+Copyright (C) 2019-2020 Abigail Gold, 0x5c
+
+This file is part of discord-qrmbot and is released under the terms of
+the GNU General Public License, version 2.
+"""
+
+
+title = "US Callsign Rules"
+emoji = "🇺🇸"
+desc = ("#x# is the number of letters in the prefix and suffix of a callsign. "
+        "E.g., WY4RC would be a 2x2 callsign, with prefix WY and suffix RC.")
+calls = {
+    "**Group A** (Extra Only)": ("**Any:** K, N, W (1x2)\n"
+                                 "    AA-AL, KA-KZ, NA-NZ, WA-WZ (2x1)\n"
+                                 "    AA-AL (2x2)\n"
+                                 "*Except*\n"
+                                 "**Alaska:** AL, KL, NL, WL (2x1)\n"
+                                 "**Caribbean:** KP, NP, WP (2x1)\n"
+                                 "**Pacific:** AH, KH, NH, WH (2x1)"),
+    "**Group B** (Advanced and Extra Only)": ("**Any:** KA-KZ, NA-NZ, WA-WZ (2x2)\n"
+                                              "*Except*\n"
+                                              "**Alaska:** AL (2x2)\n"
+                                              "**Caribbean:** KP (2x2)\n"
+                                              "**Pacific:** AH (2x2)"),
+    "**Group C** (Technician, General, Advanced, Extra Only)": ("**Any Region:** K, N, W (1x3)\n"
+                                                                "*Except*\n"
+                                                                "**Alaska:** KL, NL, WL (2x2)\n"
+                                                                "**Caribbean:** NP, WP (2x2)\n"
+                                                                "**Pacific:** KH, NH, WH (2x2)"),
+    "**Group D** (Any License Class)": ("**Any Region:** KA-KZ, WA-WZ (2x3)\n"
+                                        "*Except*\n"
+                                        "**Alaska:** KL, WL (2x3)\n"
+                                        "**Caribbean:** KP, WP (2x3)\n"
+                                        "**Pacific:** KH, WH (2x3)"),
+    "**Unavailable**": ("- KA2AA-KA9ZZ: US Army in Japan\n"
+                        "- KC4AAA-KC4AAF: NSF in Antartica\n"
+                        "- KC4USA-KC4USZ: US Navy in Antartica\n"
+                        "- KG4AA-KG4ZZ: US Navy in Guantanamo Bay\n"
+                        "- KL9KAA-KL9KHZ: US military in Korea\n"
+                        "- KC6AA-KC6ZZ: Former US (Eastern and Western Caroline Islands), "
+                        "now Federated States of Micronesia (V6) and Republic of Palau (T8)\n"
+                        "- KX6AA-KX6ZZ: Former US (Marshall Islands), "
+                        "now Republic of the Marshall Islands (V73)\n"
+                        "- Any suffix SOS or QRA-QUZ\n"
+                        "- Any 2x3 with X as the first suffix letter\n"
+                        "- Any 2x3 with AF, KF, NF, or WF prefix and suffix EMA: FEMA\n"
+                        "- Any 2x3 with AA-AL, NA-NZ, WC, WK, WM, WR, or WT prefix: \"Group X\"\n"
+                        "- Any 2x1, 2x2, or 2x3 with KP, NP, WP prefix and 0, 6, 7, 8, 9 number\n"
+                        "- Any 1x1 callsign: Special Event")
+}

resources/img/maps/meta.json

@@ -1,6 +1,10 @@
 {
-    "arrl": ["arrl-rac.png", "ARRL Sections", "ARRL Sections", "", "", "🇺🇸"],
+    "arrl": ["arrl-rac.png", "ARRL Sections", "ARRL Sections", "", "[EI8IC](https://www.mapability.com/ei8ic/maps/maps.php)", "🇺🇸"],
-    "rac": ["arrl-rac.png", "RAC Sections", "RAC Sections", "", "", "🇨🇦"],
+    "rac": ["arrl-rac.png", "RAC Sections", "RAC Sections", "", "[EI8IC](https://www.mapability.com/ei8ic/maps/maps.php)", "🇨🇦"],
     "cn": ["cn.png", "China's Prefixes", "Map of prefix regions in China", "", "CRAC", "🇨🇳"],
-    "us": ["us.png", "USA's Prefixes", "Map of prefix regions in the USA", "", "*[ARRL WAS Map](https://www.arrl.org/was-forms)*  [[PDF]](http://www.arrl.org/files/file/Awards%20Application%20Forms/WASmap_Color.pdf)", "🇺🇸"]
+    "us": ["us.png", "USA's Prefixes", "Map of prefix regions in the USA", "", "*[ARRL WAS Map](https://www.arrl.org/was-forms)*  [[PDF]](http://www.arrl.org/files/file/Awards%20Application%20Forms/WASmap_Color.pdf)", "🇺🇸"],
+    "ca": ["ca.png", "Canada's Prefixes", "Map of the prefix regions in Canada", "", "[Denelson83 (Wikimedia Commons)](https://commons.wikimedia.org/wiki/File:Amateur_radio_prefixes_in_Canada.svg)", "🇨🇦"],
+    "ituz": ["itu-zones.png", "ITU Zones", "ITU Zones", "", "[EI8IC](https://www.mapability.com/ei8ic/maps/maps.php)", "🇺🇳"],
+    "itur": ["itu-regions.png", "ITU Regions", "ITU Regions", "These are also used by the IARU for their regions.", "[EI8IC](https://www.mapability.com/ei8ic/maps/maps.php)", "🇺🇳"],
+    "cq": ["cq-zones.png", "CQ Zones", "CQ Zones", "These are used for the CQWW contest.", "[EI8IC](https://www.mapability.com/ei8ic/maps/maps.php)", "🌐"]
 }

templates/data/options.py

@@ -15,7 +15,10 @@ Settings and options for the bot.
 
 # The prefix for the bot (str). Define a list of stings for multiple prefixes.
 # ie: `["?", "!", "pls "]`
-prefix = "?"
+prefix = ["? ", "?"]
+
+# The prefix to use for display purposes (ex: status message).
+display_prefix = "?"
 
 # Whether the bot should print full stacktraces for normal exceptions: `True`,
 # or be nice and only print small messages: `False` (the default).
@@ -27,7 +30,7 @@ debug = False
 owners_uids = (200102491231092736,)
 
 # The extensions to load when running the bot.
-exts = ["ae7q", "base", "fun", "grid", "ham", "image", "lookup", "morse", "qrz", "study", "weather"]
+exts = ["ae7q", "base", "fun", "grid", "ham", "image", "lookup", "morse", "qrz", "study", "weather", "dbconv"]
 
 # Either "time", "random", or "fixed" (first item in statuses)
 status_mode = "fixed"
@@ -46,6 +49,9 @@ time_statuses = [("with lids on 3.840", (00, 00), (6, 00)),
                  ("with lids on 7.200", (18, 00), (20, 00)),
                  ("with lids on 3.840", (20, 00), (23, 59))]
 
+# append " | {display_prefix}help" to the Discord playing status
+show_help = False
+
 # Emoji IDs and keywords for emoji reactions
 # Use the format {emoji_id (int): ("tuple", "of", "lowercase", "keywords")}
 msg_reacts = {}