API update: schema return objects, endpoint tweaks

.dockerignore

@@ -0,0 +1,10 @@
+fly.toml
+app
+battlechess_standalone
+client
+data
+ia
+tests
+.vscode
+.pytest_cache
+.github

.editorconfig

@@ -0,0 +1,28 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = true
+
+[*.sql]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = true
+
+[*.yaml, *.yml]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = true

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+extend-ignore = E226,E302,E41,W503,E203
+max-line-length = 105
+exclude = .git,__pycache__,docs/source/conf.py,old,build,dist

.github/workflows/main.yml

@@ -8,25 +8,38 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8]
+        python-version: ["3.8", "3.9", "3.10"]
+        poetry-version: ["1.7.1"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
+    - name: Run image
+      uses: abatilo/actions-poetry@v2
+      with:
+        poetry-version: ${{ matrix.poetry-version }}
+    - name: Setup a local virtual environment (if no poetry.toml file)
       run: |
-        python -m pip install --upgrade pip
-        pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        poetry config virtualenvs.create true --local
+        poetry config virtualenvs.in-project true --local
+    - uses: actions/cache@v3
+      name: Define a cache for the virtual environment based on the dependencies lock file
+      with:
+        path: ./.venv
+        key: venv-${{ hashFiles('poetry.lock') }}
+    - name: Install dependencies
+      run: poetry install
     #- name: Lint with flake8
     #  run: |
     #    # stop the build if there are Python syntax errors or undefined names
     #    flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
     #    # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
     #    flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Test with pytest
-      run: |
-        pytest
+      run: poetry run pytest -v
+      env:
+        SECRET_KEY: ${{ secrets.SECRET_KEY }}
+

.gitignore

@@ -12,3 +12,7 @@ bin
 .vscode
 sql_app.db
 test.db
+*.db
+*.sqlite
+
+.env

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+profile=black

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+        args: ['--unsafe']
+      - id: trailing-whitespace
+      - id: detect-private-key
+      - id: name-tests-test
+        args: ["--pytest-test-first"]
+  - repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/isort
+    rev: 5.11.5
+    hooks:
+      - id: isort
+        name: isort (python)
+        args: ["--profile", "black", "--filter-files"]
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # Ruff version.
+    rev: "v0.0.261"
+    hooks:
+      - id: ruff
+fail_fast: false
+files: ".*"
+exclude: "desktop.ini"

Dockerfile

@@ -0,0 +1,24 @@
+# https://hub.docker.com/_/python
+FROM python:3.10-slim-bookworm
+
+ENV PYTHONUNBUFFERED True
+
+RUN apt-get update && apt-get install -y \
+    python3-pip \
+    python3-venv \
+    python3-dev \
+    python3-setuptools \
+    python3-wheel
+
+RUN mkdir -p /app
+WORKDIR /app
+
+COPY requirements.txt .
+
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . ./
+
+EXPOSE 8000
+
+CMD ["uvicorn", "battlechess.server.btchApi:app", "--host", "0.0.0.0", "--port", "8000"]

Procfile

@@ -0,0 +1 @@
+web: uvicorn battlechess.server.btchApi:app --host=0.0.0.0 --port=${PORT:-5000}

Readme.md → README.md

@@ -35,6 +35,8 @@ That new rule has some direct consequences on the gameplay.
 
 ## Installation :
 
+### Battlechess standalone (LAN)
+
 - What you need :
 	* [python 3.7](https://www.python.org/downloads/) (or more I guess...)
 	* [pygame 1.9.2](http://www.pygame.org/download.shtml). On OS X with python 2.7, you should donwload this [installation file](http://www.pygame.org/ftp/pygame-1.9.2pre-py2.7-macosx10.7.mpkg.zip)
@@ -57,9 +59,11 @@ That new rule has some direct consequences on the gameplay.
 	`python battleChess.py -p http://sxbn.org/~antoine/games/2014_03_07_14_06_37_lance_hardwood_Vs_sniper.txt`
 	`python battleChess.py -p ./2014_03_07_14_06_37_lance_hardwood_Vs_sniper.txt`
 
+### Battlechess api server
+
 - Using the server application :
 	If you want to host your own server (you don't have to). You just need to run the api with
-	`$ uvicorn server.btchApi:app --reload`
+	`$ uvicorn battleches.server.btchApi:app --reload`
 	program on a computer that can be reached through the network. Change the port and hostname if you want and pass those informations to the client application. Check `$ uvicorn --help`.
 	You'll need to install the packages listed in `requirements.txt`. You can do so with `$ pip install -r requirements.txt`