Merge pull request #3 from WizzyGeek/devops

Add configuration for tox, poetry and mypy

.github/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+<!-- TODO, write more about tox and poetry later -->
+
+# What you need.
+
+Install tox as mentioned [here](https://tox.wiki/en/latest/installation.html)
+
+Then install poetry as detailed [here](https://python-poetry.org/docs/#installation)
+
+
+
+## Adding a dependency
+Warning, never use pip to add a dependency. Nasty things are gonna
+happen if you ignore that advice.
+
+```
+$ poetry add yourdep yourdep2 ...
+```
+
+The command may take time due to dependency resolution sometimes, but
+if it exceeds 5 minutes it is abnormal. Usually it should be done before you notice.
+
+## Spawning a shell in the environment
+
+```
+$ poetry shell
+```
+
+You can learn more at https://python-poetry.org/docs/cli/
+
+## Running tests
+
+```
+$ tox r
+```

.github/workflows/tox.yml

@@ -10,18 +10,23 @@ jobs:
  build:
 
  runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ python-version: [
+ "3.11",
+ "3.12"
+ ]
 
  steps:
  # TODO: Add caching
  - uses: actions/checkout@v4
- - name: Set up Python
+ - name: Set up Python ${{ matrix.python-version }}
  uses: actions/setup-python@v4
  with:
- python-version: '3.x'
- - name: Install dependencies
+ python-version: ${{ matrix.python-version }}
+ - name: Install Tox in Python ${{ matrix.python-version }}
  run: |
- python -m pip install --upgrade pip
- pip install -r requirements.txt
- - name: Run the tox environment
+ python -m pip install tox-gh
+ - name: Run the tox environment (Python ${{ matrix.python-version }})
  run: |
  tox

OVERVIEW.md

@@ -13,7 +13,7 @@ Rough functionality:
  - clear (NEW)
   - Stops all running containers associated with the team
 - CTF
- - (id) -> Get CTF info 
+ - (id) -> Get CTF info
  - start
   - Check if team has already completed it
   - Only if no container is assigned to the team before