SpokanePython.com

Home of SpokanePython, an online hub for Spokane's tech events and groups. It's not just a website; it's a community-driven, open-source initiative aimed at fostering learning and collaboration among aspiring and seasoned tech enthusiasts.

See the live site here: https://www.spokanepython.com

Code Quality

Workflow	Description	Status
Bandit	security checks
Django Check	django project scan
FawltyDeps	dependency consistency check
Isort	python import ordering
Mypy	static type checking
Pip Audit	dependency vulnerability scan
Radon	code complexity analysis
Ruff Format	code formatting
Ruff Lint	static code analysis

Local Development

prerequisites

1. git installed on system
2. python installed on system (3.12+ recommended)

local git setup

1. clone the repo:

   git clone git@github.com:SpokaneTech/SpokanePythonWeb.git
   

2. git config (optional) To enable pre-commit code quality checks, update the location of git hooks with the following command:

   git config core.hooksPath .github/hooks

   Note: to make a commit with the precommit hooks temporarily disabled, run the following:

   git commit --no-verify
   

local environment setup steps

1. cd into the repo directory

   cd SpokanePythonWeb
   

2. create a python virtual environment

   python -m venv venv
   

3. activate the python virtual environment

   for linux, mac, or wsl:

   source venv/bin/activate
   

   for powershell:

   venv\Scripts\activate

4. install the python dependencies

   pip install .[dev]
   

   ** mac users may need to use quotes, such as pip install ."[dev]"

5. (optional) create a custom .env file and update contents as applicable

   cp src/envs/.env.template src/envs/.env.local
   

6. cd to the django_project directory

   cd src/django_project
   

7. create a local database by running django migrations

   ./manage.py migrate
   

8. create a local admin user

   ./manage.py add_superuser --group admin
   

9. (optional) add platforms and groups to your local database

   ./manage.py runscript initialize_data
   

10. start the local demo server

    ./manage.py runserver
    

open a browser and navigate to http://127.0.0.1:8000 (log in with admin/admin)

** you can stop the local demo server anytime via ctrl + c