Feat: Various fixes across the application (#127)

* chore(pyproject): update install steps and change to using uv
* chore: python version pinned to 3.11
* chore(format): ran the formatter over the entire project
* fix(ci): split test and dev dependencies again, update action script
* fix(ci): removed requirements.txt requirement
* fix(uv): update uv.lock to current state
* refactor(permissions): rewrote permissions to integrate admin types
* fix: type errors in officers crud
* refactor(permissions): restructured most endpoints to use Depends
* tests: whole test suite can now be run
* fix: missing awaits on permission check calls
* fix: move `conftest.py` to only work on integrations tests
* feat: add GET all registrations
* feat(nominee): add create endpoint
* feat: add GET all nominees
* feat: add DELETE nominee_info
* fix(Elections): duplicate operation id in nominees URLs
* refactor: split election tests into multiple functions
* fix(tests): split admin elections tests
* fix(permissions): fixed some permission tests to be more efficient
* refactor: update Nominee model names
* fix(registrations): change return type to list
* fix(registration): fix list being sent as a JSON response
* refactor(officers): response for current officers changed to list
* fix(officers): tests that expect a dict response for current officers
* fix(Officers): merged the public and private models
* chore(OfficerInfoDB): remove unused methods
* fix(test): user client is now module scoped
* fix(officers): model fields use OfficerPositionEnum
* refactor: made  a computed field
* fix(officers): term_id added to Officer response, id is now an int
* refactor: rename OfficerUpdate to OfficerInfoUpdate
* refactor: change csss_email to a computed field
* chore(officers): delete old dataclass types
* fix: remove csss_email
* fix: check that end_date is null for current officers
* fix: tests failed after the check for current admin changed
* fix: made all timestamps timezone aware, UTC stored now
* chore(tables): rename the rest of the DB tables
* refactor(nominee): update nominee models and PATCH request
* refactor(candidates): renamed registrations to candidates
* fix(alembic): registration renamed to candidates
* fix(nominee): update POST to use create model
* fix(candidates): missed some renames
* fix(candidates): updating a candidate with the same position failed
* tests(nominee): created base tests
* fix(tests): databases now persist for an entire test module (file)
    * note: this has broken some tests

Author: jbriones1

.github/workflows/alembic.yml

@@ -38,7 +38,7 @@ jobs:
           python3.11 -m pip install --upgrade pip
           python3.11 -m venv venv
           source ./venv/bin/activate
-          pip install -r requirements.txt
+          pip install .
 
       # This will fail if there are divergent heads and alembic gets confused;
       #   e.g., un-sanitarily merging main into a dev branch.

.github/workflows/pytest_unit.yml

@@ -26,7 +26,7 @@ jobs:
           python -m pip install --upgrade pip
           python -m venv venv
           source ./venv/bin/activate
-          pip install -r requirements.txt
+          pip install ".[test]"
 
       - name: Run unit tests
         run: PYTHONPATH=src ./venv/bin/python -m pytest ./tests/unit -v

.gitignore

@@ -8,6 +8,10 @@ google_key.json
 # Python - Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
+build/
+dist/
+wheels
+*.egg-info/
 *$py.class
 
 .venv

README.md

@@ -12,6 +12,35 @@ See [the csss-backend wiki](https://github.com/CSSS/csss-site-backend/wiki/1.-Lo
 
 If you're planning to read through the source code, please check out this project's [naming conventions](https://github.com/CSSS/csss-site-backend/wiki/Style-Guide#naming-conventions).
 
+### Quickstart
+
+1. Install [Python 3.11](https://www.python.org/downloads/), [git](https://git-scm.com/install/), and (optionally) [Docker](https://www.docker.com/get-started/)
+    Note: This may fail if you're using Python 3.12+
+2. Clone this repository
+3. Create and activate a virtual environment for this project. This has been tested with `pip` and `uv`
+4. Install developer dependencies
+```bash
+# Install main dependencies
+pip install .        # or: uv pip install .
+
+# Install with dev dependencies
+pip install ".[dev]" # or: uv pip install ".[dev]"
+
+# Install with test dependencies
+pip install ".[test]" # or: uv pip install ".[test]"
+
+# Install with all dependencies
+pip install ".[dev, test]" # or: uv pip install ".[dev, test]"
+```
+
+5. Follow the database setup instructions on the [wiki](https://github.com/CSSS/csss-site-backend/wiki/1.-Local-Setup#database-setup). The recommended way is to do it through Docker, but both should work.
+6. You will need to set the following environment variables
+```bash
+export DB_PORT=5444 # The port your database is listening at
+export LOCAL=true # Should be true if you're running this locally
+```
+
+
 ## Important Directories
 
 - `config/` configuration files for the server machine
@@ -26,6 +55,7 @@ If you're planning to read through the source code, please check out this projec
     - `officers/` for officer contact information + photos
 - `test/` for html pages which interact with the backend's local api
 
-## Linter
+## Developer Tools
 
 We use `ruff 0.6.9` as our linter, which you can run with `ruff check --fix`. If you use a different version, it may be inconsistent with our CI checks.
+We use `pyright/basedpyright` for typechecking. Language services have been left enabled and will be changed if it becomes an issue.

pyproject.toml

@@ -1,26 +1,58 @@
 [project]
 name = "csss-site-backend"
 version = "0.1"
-requires-python = ">= 3.11" # older versions untested, but we use new features often
+requires-python = "~=3.11.0" # older versions untested, but we use new features often
+
+dependencies = [
+    # major
+    "fastapi==0.115.6",
+    "gunicorn==21.2.0",
+    "uvicorn[standard]==0.27.1",
+    "sqlalchemy[asyncio]==2.0.27",
+    "asyncpg==0.29.0",
+    "alembic==1.13.1",
+    "google-api-python-client==2.143.0",
+
+    # minor
+    "pyOpenSSL==24.0.0", # for generating cryptographically secure random numbers
+    "xmltodict==0.13.0",
+    "requests==2.31.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "ruff==0.6.9", # linting and formatter
+]
+
+test = [
+    "pytest", # test framework
+    "pytest-asyncio",
+    "httpx",
+]
 
 [project.urls]
 Homepage = "https://api.sfucsss.org/"
 
+# Pytest: Test framework
 [tool.pytest.ini_options]
 pythonpath = ["src"]
 log_cli = true
 log_cli_level = "INFO"
 testpaths = [
     "tests",
-  ]
+]
 norecursedirs = "tests/wip"
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"
 
+# Ruff: Formatter and linter
 [tool.ruff]
 line-length = 120
 indent-width = 4
 target-version = "py311"
+exclude = [
+    "src/alembic/*"
+]
 
 [tool.ruff.format]
 quote-style = "double"
@@ -31,6 +63,12 @@ line-ending = "lf"
 select = ["E", "F", "B", "I", "N", "UP", "A", "PTH", "W", "RUF", "C4", "PIE", "Q", "FLY"] # "ANN"
 ignore = ["E501", "F401", "N806"]
 
+# [Based]Pyright: Type checker/LSP
 [tool.pyright]
-executionEnvironments = [{ root = "src" }]
+executionEnvironments = [
+    { root = "src", pythonVersion = "3.11" },
+    { root = "tests", extraPaths=["src"], pythonVersion = "3.11" }
+]
 typeCheckingMode = "standard"
+reportAny = "none" # Allow the use of `Any` type
+reportExplicitAny = "none" # Allow the declaration of `Any` type

requirements.txt

@@ -0,0 +1 @@
+from . import dependencies

src/__init__.py

@@ -6,6 +6,7 @@
 GMAIL_ADDRESS = "csss-site@gmail.com"
 GMAIL_USERNAME = ""
 
+
 # TODO: look into sending emails from an sfu maillist (this might be painful)
 def send_email(
     recipient_address: str,
@@ -22,4 +23,3 @@ def send_email(
 
     mail.sendmail(GMAIL_ADDRESS, recipient_address, content)
     mail.quit()
-

src/admin/email.py

@@ -11,7 +11,7 @@
 import elections.tables
 import nominees.tables
 import officers.tables
-import registrations.tables
+import candidates.tables
 from alembic import context
 
 # this is the Alembic Config object, which provides
@@ -62,6 +62,9 @@ async def run_async_migrations() -> None:
     and associate a connection with the context.
     """
     configuration = config.get_section(config.config_ini_section)
+    if not configuration:
+        return
+
     configuration["sqlalchemy.url"] = database.SQLALCHEMY_DATABASE_URL
     connectable = async_engine_from_config(
         configuration,