feat: re-init (#3)

* new project init

* pre-commit fix

* delete old code

* update actions

* test

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update readme

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: QMasterMoo

.env.example

@@ -1 +1 @@
-SLACK_BOT_TOKEN=<token from slack>
+SLACK_BOT_TOKEN=<token from slack>

.github/workflows/linter_black.yaml

@@ -0,0 +1,51 @@
+# TODO FOR THIS REPO
+
+#name: Publish artifacts
+#
+#on:
+#  push:
+#    #branches: ['release']
+#    branches: ['main']
+#
+#env:
+#  REGISTRY: ghcr.io
+#  IMAGE_NAME: ${{ github.repository }}
+#
+#jobs:
+#  build-and-push-image:
+#    runs-on: ubuntu-latest
+#
+#    permissions:
+#      contents: read
+#      packages: write
+#
+#    steps:
+#      - name: Checkout repository
+#        uses: actions/checkout@v4
+#
+#      - name: Log in to the Container registry
+#        uses: docker/login-action@v3
+#        with:
+#          registry: ${{ env.REGISTRY }}
+#          username: ${{ github.actor }}
+#          password: ${{ secrets.GITHUB_TOKEN }}
+#
+#      # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
+#      # - name: Extract metadata (tags, labels) for Docker
+#      #   id: meta
+#      #   uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+#      #   with:
+#      #     images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+#
+#      # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
+#      # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
+#      # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
+#      - name: Build and push Docker image
+#        uses: docker/build-push-action@v6
+#        with:
+#          context: .
+#          push: true
+#          #tags: ${{ steps.meta.outputs.tags }}
+#          #labels: ${{ steps.meta.outputs.labels }}
+#          # hardcoding while it's runnin off main
+#          tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest

.github/workflows/publish.yml

@@ -1,19 +1,164 @@
-# python
-*.pyc
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
 
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
 .env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
 
-# auto generated idk
-*.egg-info
+# pytype static type analyzer
+.pytype/
 
-#pyenv
-.python-version
+# Cython debug symbols
+cython_debug/
 
-# local data
-local_test.py
-local_test_data/*
-local_test_output/*
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
 
-# ignore pycharm stuff for now
-.idea
-.idea/*
+tmp/

.gitignore

@@ -0,0 +1,26 @@
+# whale-net python pre-commit v1
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  -   repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v5.0.0
+      hooks:
+        - id: trailing-whitespace
+        - id: end-of-file-fixer
+        # -   id: check-yaml
+        - id: check-added-large-files
+        - id: mixed-line-ending
+          args: [ --fix=lf ]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.7.2
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
+
+ci:
+  # should test this one day, but for now not enabling
+  autofix_prs: false

.pre-commit-config.yaml

@@ -0,0 +1 @@
+3.11

.python-version

@@ -1,42 +1,20 @@
 # friendly-computing-machine
 slackbot
 
-
 ## environment
-pyenv: https://github.com/pyenv/pyenv
-python version 3.10.7 (for now, will be configurable in future)
-```
-pyenv install 3.10.7
-```
-pyenv virtual environment: https://github.com/pyenv/pyenv-virtualenv
-makes package management easier for test version of python
-i named my environment friendly-computing-machine
-```
-pyenv virtualenv 3.10.7 friendly-computing-machine
-```
-
-to make version management easier between different repos, create a .python-version file locally
-```
-echo 'friendly-computing-machine' > .python-version
+uv
 ```
-
-if your bash config is setup correctly with pyenv and pyenv-virtualenv then
-you should be get the following
-```
-user@computer:~/friendly-computing-machine$ pyenv version
-friendly-computing-machine (set by /home/user/friendly-computing-machine/.python-version)
-```
-
-run setup.py
-```
-pip install -e .
+uv venv
+source .venv/bin/activate
+uv sync
 ```
 
 your environment is now setup
 
+(optional) update your IDE to use `./.venv/bin/python`
+
 ## run
 run the bot (or whatever this currently is)
 ```
-python run.py
+uv run fcm
 ```
-

README.md

@@ -0,0 +1,17 @@
+[project]
+name = "friendly-computing-machine"
+version = "0.1.0"
+description = "slackbot"
+readme = "README.md"
+authors = [
+    { name = "qmastermoo", email = "alex.harding@gmail.com" }
+]
+requires-python = ">=3.11"
+dependencies = []
+
+[project.scripts]
+fcm = "friendly_computing_machine:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

pyproject.toml

@@ -0,0 +1,2 @@
+def main() -> None:
+    print("Hello from friendly-computing-machine!")