Spunky Sputniks

spunky-sputniks/.github/workflows/build.yml

@@ -0,0 +1,49 @@
+name: Build
+
+on:
+    push:
+        tags:
+            - v*
+
+concurrency:
+    group: build-${{ github.head_ref }}
+
+jobs:
+    build:
+        name: Build wheels and source distribution
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Install build dependencies
+              run: python -m pip install --upgrade build
+
+            - name: Build
+              run: python -m build
+
+            - uses: actions/upload-artifact@v3
+              with:
+                  name: artifacts
+                  path: dist/*
+                  if-no-files-found: error
+
+    publish:
+        name: Publish release
+        needs:
+            - build
+        if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/download-artifact@v3
+              with:
+                  name: artifacts
+                  path: dist
+
+            - name: Push build artifacts to PyPI
+              uses: pypa/[email protected]
+              with:
+                  skip_existing: true
+                  user: __token__
+                  password: ${{ secrets.PYPI_API_TOKEN }}

spunky-sputniks/.github/workflows/lint.yaml

@@ -0,0 +1,35 @@
+# GitHub Action workflow enforcing our code style.
+
+name: Lint
+
+# Trigger the workflow on both push (to the main repository, on the main branch)
+# and pull requests (against the main repository, but from any repo, from any branch).
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+
+# Brand new concurrency setting! This ensures that not more than one run can be triggered for the same commit.
+# It is useful for pull requests coming from the main repository since both triggers will match.
+concurrency: lint-${{ github.sha }}
+
+jobs:
+    lint:
+        runs-on: ubuntu-latest
+
+        env:
+            # The Python version your project uses. Feel free to change this if required.
+            PYTHON_VERSION: "3.12"
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Set up Python ${{ env.PYTHON_VERSION }}
+              uses: actions/setup-python@v5
+              with:
+                  python-version: ${{ env.PYTHON_VERSION }}
+
+            - name: Run pre-commit hooks
+              uses: pre-commit/[email protected]

spunky-sputniks/.github/workflows/tests.yml

@@ -0,0 +1,41 @@
+name: Tests
+
+on:
+    push:
+        branches:
+            - main
+        paths:
+            - src/discobase/**
+    pull_request:
+        branches:
+            - main
+        paths:
+            - src/discobase/**
+
+concurrency:
+    group: test-${{ github.head_ref }}
+    cancel-in-progress: true
+
+env:
+    PYTHONUNBUFFERED: "1"
+    FORCE_COLOR: "1"
+    TEST_BOT_TOKEN: ${{ secrets.TEST_BOT_TOKEN }}
+
+jobs:
+    run-container-matrix:
+        name: Test matrix on Linux
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Set up Python 3.12
+              uses: actions/setup-python@v4
+              with:
+                  python-version: "3.12"
+
+            - name: Install Hatch
+              run: pip install --upgrade hatch
+
+            - name: Run tests in matrix
+              run: hatch test --all

spunky-sputniks/.gitignore

@@ -0,0 +1,35 @@
+# Files generated by the interpreter
+__pycache__/
+*.py[cod]
+
+# Environment specific
+.venv
+venv
+.env
+env
+
+# Unittest reports
+.coverage*
+
+# Logs
+*.log
+
+# PyEnv version selector
+.python-version
+
+# Built objects
+*.so
+dist/
+build/
+
+# IDEs
+# PyCharm
+.idea/
+# VSCode
+.vscode/
+# MacOS
+.DS_Store
+
+# Builds
+dist/
+test.py

spunky-sputniks/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+# Pre-commit configuration.
+# See https://github.com/python-discord/code-jam-template/tree/main#pre-commit-run-linting-before-committing
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.3
+    hooks:
+      - id: ruff
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        name: isort (python)

spunky-sputniks/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2021 Python Discord
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

spunky-sputniks/README.md

@@ -0,0 +1,57 @@
+<div align="center">
+    <img alt="discobase logo" src="https://raw.githubusercontent.com/ZeroIntensity/discobase/main/docs/assets/discobase_blurple.png" width=500>
+    <br><br>
+    <div align="center"><strong>Python Discord Codejam 2024 Submission: Spunky Sputniks</strong></div>
+</div>
+<br>
+
+## Installation
+
+### Library
+
+```bash
+$ pip install discobase
+```
+
+### Demo Bot
+
+You can add the demo bot to a server with [this integration](https://discord.com/oauth2/authorize?client_id=1268247436699238542&permissions=8&integration_type=0&scope=bot), or self-host it using the following commands:
+
+```bash
+$ git clone https://github.com/zerointensity/discobase
+$ cd discobase/src/demo
+$ export DB_BOT_TOKEN="first bot token"
+$ export BOOKMARK_BOT_TOKEN="second bot token"
+$ python3 main.py
+```
+
+## Quickstart
+
+```py
+import asyncio
+import discobase
+
+db = discobase.Database("My database")
+
+@db.table
+class User(discobase.Table):
+    name: str
+    password: str
+
+async def main():
+    async with db.conn("My bot token"):
+        admin = await User.find(name="admin")
+        if not admin:
+            User.save(name="admin", password="admin")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Documentation
+
+Documentation is available [here](https://discobase.zintensity.dev).
+
+## License
+
+`discobase` is distributed under the `MIT` license.

spunky-sputniks/docs/demonstration.md

@@ -0,0 +1,20 @@
+---
+hide:
+    - navigation
+---
+
+# Demonstration
+
+Now, we know that Discobase's main functionality is just a database for storing data: we're allowing developers to access this "database" to make their own applications.
+
+Quotes are applied around the term database because, as mentioned earlier, the database is actually a Discord server created by the user (or by the Discobase bot in many cases), making Discobase the intermediary to couple this connection.
+
+If we look at the scenairo below, a developer—from our team—has programmed a message bookmarking bot that uses the Discord context menu feature `App -> Bookmark` to store away the message onto the database.
+
+![demo_bot](assets/demo_bot.gif)
+
+This bot doesn't use any other database — no SQL, no MongoDB, nothing! Just our very own library, which stores it on a Discord server.
+
+After storing away our pertinent message to the database, we can use a slash command as per the developer's generous design to get all the bookmarks we've stored away.
+
+If you want to try this for yourself, you can [invite the bookmark bot](https://discord.com/oauth2/authorize?client_id=1268247436699238542&permissions=8&integration_type=0&scope=bot) to your server.