ref!: various upgrades and fixes

Author: Diaoul

.pre-commit-config.yaml

@@ -1,6 +1,7 @@
+---
 repos:
   - repo: https://github.com/python-poetry/poetry
-    rev: master
+    rev: 1.2.2
     hooks:
       - id: poetry-export
   - repo: https://github.com/psf/black

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.9.7-buster
+FROM python:3.10
 
 WORKDIR /usr/src/app
 

README.md

@@ -7,37 +7,33 @@ Synology Package Repository
 
 ## Development
 ### Installation
-1. Install dependencies with `poetry install`
-2. Run the next commands in the virtual environment `poetry shell`
-3. Create the tables with `python manage.py create`
-4. Populate the database with some fake packages with `python manage.py populate`
-5. Add an user with `python manage.py user create -u Admin -e [email protected] -p adminadmin`
-6. Grant the created user with Administrator permissions `python manage.py roles add [email protected] admin`
-7. Grant the created user with Package Administrator permissions `python manage.py roles add [email protected] package_admin`
-8. Grant the created user with Developer permissions `python manage.py roles add [email protected] developer`
-
-To reset the environment, clean up with `python manage.py clean`.
+1. Run postgres, e.g. using docker with `docker-compose up db`
+2. Install dependencies with `poetry install`
+3. Run the next commands in the virtual environment `poetry shell`
+4. Create the tables with `flask db upgrade`
+5. Populate the database with some fake packages with `flask spkrepo populate_db`
+6. Add a user with `flask users create username:admin email:[email protected] --password adminadmin`
+7. Grant the created user with Administrator permissions `flask roles add [email protected] admin`
+8. Grant the created user with Package Administrator permissions `flask roles add [email protected] package_admin`
+9. Grant the created user with Developer permissions `flask roles add [email protected] developer`
+
+To clean data created by fake packages, run `flask spkrepo clean`
 
 ### Run
-1. Start the development server with `python manage.py run`
-2. Website is available at http://localhost:5000
-3. Admin interface is available at http://localhost:5000/admin
-4. NAS interface is available at http://localhost:5000/nas
-5. API is available at http://localhost:5000/api
-6. Run the test suite with `poetry run pytest -v`
+1. Start postgres with `docker-compose up db`
+2. Start the development server with `flask run`
+3. Website is available at http://localhost:5000
+4. Admin interface is available at http://localhost:5000/admin
+5. NAS interface is available at http://localhost:5000/nas
+6. API is available at http://localhost:5000/api
+7. Run the test suite with `pytest -v`
 
 ## Docker Compose Run
-It is also possible to start a development environment with postgres database
-using docker compose:
-1. Build and run `docker-compose up --build`
-2. On first run you can apply database migrations with `docker exec spkrepo_spkrepo_1 python manage.py db upgrade`.
-   Also run any other command that you need (populate the databse, create user) as mentioned above but by prefixing
-   with `docker exec {container_id} [...]`.
-3. Browse to http://localhost:5000
-4. To tear down the environment, run `docker-compose down --remove`
+- If you also want to run the app in docker you can with `docker-compose up app`
+- You can run both postgres and the app with `docker-compose up`
 
-## Deployment
 
+## Deployment
 ### Configuration
 Create a config file `./config.py` to disable debug logs, connect to a database, set a secure key and optionally set a cache:
 

docker-compose.yaml

@@ -1,19 +1,23 @@
-version: "3.9"
+---
+version: '3.8'
+
 services:
   db:
-    image: postgres:13
+    image: postgres:15
     environment:
       POSTGRES_DB: spkrepo
       POSTGRES_USER: spkrepo
       POSTGRES_PASSWORD: spkrepo
-  spkrepo:
-      build: .
-      command: python manage.py runserver -h 0.0.0.0
-      ports:
-        - "5000:5000"
-      environment:
-        SPKREPO_SQLALCHEMY_DATABASE_URI: postgresql://spkrepo:spkrepo@db/spkrepo
-      volumes:
-        - .:/usr/src/app/
-      depends_on:
-        - db
+    ports:
+      - 5432:5432
+  app:
+    build: .
+    command: flask run -h 0.0.0.0
+    ports:
+      - 5000:5000
+    environment:
+      SPKREPO_SQLALCHEMY_DATABASE_URI: postgresql://spkrepo:spkrepo@db/spkrepo
+    volumes:
+      - .:/usr/src/app/
+    depends_on:
+      - db

migrations/versions/76d559b4e873_add_fs_uniquifier.py

@@ -0,0 +1,28 @@
+"""Add fs_uniquifier
+
+Revision ID: 76d559b4e873
+Revises: dc7687894ba7
+Create Date: 2022-10-24 09:31:01.814928
+
+"""
+revision = "76d559b4e873"
+down_revision = "dc7687894ba7"
+
+import sqlalchemy as sa
+from alembic import op
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column(
+        "user", sa.Column("fs_uniquifier", sa.String(length=255), nullable=False)
+    )
+    op.create_unique_constraint(None, "user", ["fs_uniquifier"])
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint(None, "user", type_="unique")
+    op.drop_column("user", "fs_uniquifier")
+    # ### end Alembic commands ###

migrations/versions/d785f1fb2307_.py renamed to migrations/versions/d785f1fb2307_dsm6_fields.py

@@ -1,4 +1,4 @@
-"""empty message
+"""Increase field sizes
 
 Revision ID: dc7687894ba7
 Revises: d785f1fb2307