Merge latest main

.github/pull_request_template.md

@@ -4,19 +4,8 @@ Relevant issue: {issue url}
 
 {description}
 
-## Screenshots:
-
-{if applicable}
-
-## Testing Instructions:
-
-{testing instructions}
-
 ## Checklist:
 
 - [ ] Code Quality
-- [ ] Pep-8
 - [ ] Tests (if applicable)
-- [ ] Success Criteria Met
 - [ ] Inline Documentation
-- [ ] Wiki Documentation (if applicable)

.github/workflows/build_and_release.yml

@@ -0,0 +1,41 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.10.x'
+    - name: Install Env
+      # shiv will download the dependencies it needs on its own
+      run: |
+        pip install --upgrade pip
+        pip install shiv
+        pip install poetry
+        pip install git+https://github.com/abersheeran/poetry2setup@master
+    - name: Add CURRENT_TIME env property
+      # the smart thing to do here would be to use the commit hash, but
+      # github releases are ALPHABETIZED, so a commit hash of `abcdef` will
+      # not be listed as the latest release if `defabc` came before. (╥﹏╥)
+      run: echo "CURRENT_TIME_VERSION=v$(date '+%s')" >> $GITHUB_ENV
+    - name: Build the sucker
+      run: |
+        sed -i -e "s/?????/${{ env.CURRENT_TIME_VERSION }}/g" bubbles/__init__.py
+        make build
+    - uses: ncipollo/release-action@v1
+      with:
+        artifacts: "build/bubbles.pyz"
+        body: "It's releasin' time"
+        generateReleaseNotes: true
+        tag: ${{ env.CURRENT_TIME_VERSION }}
+        commit: main
+        token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/static_analysis.yml

@@ -0,0 +1,26 @@
+name: Static Code Analysis
+
+on: [pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout current branch
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: Set up Python 3.10.x
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.10.x
+    - uses: snok/install-poetry@v1
+      with:
+        virtualenvs-create: true
+    - name: Install Dependencies
+      run: poetry install
+    - name: Run Static Analysis
+      run: |
+        poetry run ruff .

.github/workflows/test_build.yml

@@ -0,0 +1,34 @@
+name: Build bubbles.pyz and test
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.10.x'
+    - name: Install Env
+      # shiv will download the dependencies it needs on its own
+      run: |
+        pip install --upgrade pip
+        pip install shiv
+        pip install poetry
+        pip install git+https://github.com/abersheeran/poetry2setup@master
+    - name: Add CURRENT_TIME env property
+      # the smart thing to do here would be to use the commit hash, but
+      # github releases are ALPHABETIZED, so a commit hash of `abcdef` will
+      # not be listed as the latest release if `defabc` came before. (╥﹏╥)
+      run: echo "CURRENT_TIME_VERSION=v$(date '+%s')" >> $GITHUB_ENV
+    - name: Build the sucker
+      run: |
+        sed -i -e "s/?????/${{ env.CURRENT_TIME_VERSION }}/g" bubbles/__init__.py
+        make build
+    - name: Remove source to make sure it doesn't interfere with the tests
+      run: rm -rf bubbles/
+    - name: Run selfcheck on compiled binary
+      run: ./build/bubbles.pyz selfcheck

.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: Tests
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout current branch
+      uses: actions/checkout@v2
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10.x'
+    - uses: snok/install-poetry@v1
+      with:
+        virtualenvs-create: true
+    - name: Install Dependencies
+      run: |
+        poetry install
+    - name: Run Tests
+      run: |
+        poetry run pytest --cov=bubbles
+    - name: Coveralls
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: poetry run coveralls --service=github

.gitignore

@@ -114,3 +114,7 @@ presence_log.json
 
 asdf.py
 test.py
+
+# build artifacts
+bubbles.pyz
+setup.py

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+-   repo: https://github.com/ambv/black
+    rev: 22.3.0
+    hooks:
+    - id: black
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.265
+    hooks:
+    - id: ruff

.ruff.toml

@@ -0,0 +1,35 @@
+select = [
+    "E",  # pycodestyle (error)
+    "W",  # pycodestyle (warning)
+    # TODO: Enable this again
+    #"D",  # pydocstyle
+    "I",  # isort
+    "ANN",  # flake8-annotations
+    "DTZ",  # flake8-datetimez
+]
+ignore = [
+    "ANN101",  # missing-type-self
+    "ANN401",  # any-type
+    "D100",  # undocumented-public-module
+    "D101",  # undocumented-public-class
+    "D105",  # undocumented-magic-method
+    "D106",  # undocumented-public-nested-class
+    "D203",  # one-blank-line-before-class
+    "D213",  # multi-line-summary-second-line
+    # Doesn't work well for Bubbles, because we use the doc commands also
+    # for help command output
+    "D400",  # ends-in-period
+]
+
+exclude = [
+    "build",
+    "dist",
+]
+
+line-length = 100  # Same as black
+
+[per-file-ignores]
+"test_*" = [
+    "D",  # Disable documentation lints for test files
+    "DTZ",  # Disable timezone lints for test files
+]

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+conduct@grafeas.org.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

Makefile

@@ -0,0 +1,11 @@
+setup:
+	poetry2setup > setup.py
+
+build: setup shiv
+
+clean:
+	rm setup.py
+
+shiv:
+	mkdir -p build
+	shiv --preamble bubbles/preamble.py -c bubbles -o build/bubbles.pyz . --compressed