Finish type annotations

.gitignore

@@ -0,0 +1,144 @@
+# MacOS files
+**/.DS_Store
+
+# Byte-compiled / optimized / DLL files / editor temp files
+__pycache__/
+*.py[cod]
+*$py.class
+*~
+\#*
+.#*
+*.swp
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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/
+.venv/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+.mypy_cache/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+# Sphinx documentation
+doc/_build/
+
+# PyCharm
+.idea/

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+ci:
+  autofix_prs: true
+  autoupdate_schedule: quarterly
+  submodules: false
+
+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-ast
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+      - id: check-case-conflict
+      - id: sort-simple-yaml
+        files: .pre-commit-config.yaml
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.6
+    hooks:
+      - id: ruff
+        args: ["--show-fixes"]
+      - id: ruff-format
+  - repo: https://github.com/crate-ci/typos
+    rev: typos-dict-v0.12.5
+    hooks:
+      - id: typos
+  - repo: https://github.com/woodruffw/zizmor-pre-commit
+    rev: v1.3.1
+    hooks:
+      - id: zizmor

README.md

@@ -6,7 +6,7 @@ mentors. Read about how helper duck works on the HackKU24 [hackerdoc](https://ha
 
 ## Setting up helper duck ⚙️
 To run helper duck, you will need Python and SQLite3 installed your system.
-First install the modules in `requirements.txt`. Secondly, initialize the database by running
+First install the project using `pip install -e .`. Secondly, initialize the database by running
 
 ```
 sqlite3 database.db < db_init.sql
@@ -34,10 +34,10 @@ server/role/channel you want the ID of, you will see a new option on the context
 - The Discord API token can be generated by creating a new app and bot in the [Discord developer portal](https://discord.com/developers/applications).
   Make sure to invite helper duck to your server!
 
-After that, off to the races! 🏁 Just run 
+After that, off to the races! 🏁 Just run
 
 ```
-python3 main.py
+run_helper_duck
 ```
 
 Happy hacking! 🍻