Merge pull request #20 from ArielMAJ/BREAKING_CHANGE/general-project-improvements-and-updates

BREAKING_CHANGE: general project improvements and updates;

Author: ArielMAJ

.pre-commit-config.yaml

@@ -5,6 +5,18 @@ repos:
       - id: poetry-check
       - id: poetry-lock
       - id: poetry-install
+      - id: poetry-export
+        name: Export requeriments.txt
+        args:
+          [
+            "--without-hashes",
+            "-o",
+            "requirements.txt",
+            "-f",
+            "requirements.txt",
+          ]
+        files: ^(pyproject\.toml|poetry\.lock)$
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:
@@ -90,12 +102,3 @@ repos:
     rev: v0.1.8
     hooks:
       - id: ruff
-
-  - repo: local
-    hooks:
-      - id: export-requirements
-        name: Export requeriments.txt
-        language: system
-        pass_filenames: false
-        entry: poetry export --without-hashes -o requirements.txt -f requirements.txt
-        files: ^(pyproject\.toml|poetry\.lock)$

.python-version

@@ -1 +1 @@
-3.9.18
+3.12.8

Makefile

@@ -1,11 +1,14 @@
+CONTAINER_ENGINE := $(shell which podman || which docker)
+COMPOSE := $(CONTAINER_ENGINE) compose
+
 ifneq ("$(wildcard .env)","")
 	include .env
 	export
 endif
 
 .PHONY: run
 run: ## Run the project.
-	poetry run python -m api
+	poetry run python -m src.main
 
 .PHONY: install
 install: ## Install Python package dependencies.
@@ -20,11 +23,11 @@ test: ## Run automated tests.
 
 .PHONY: up-database
 up-database: ## Start database container.
-	docker compose up -d postgres --force-recreate
+	$(COMPOSE) up -d postgres --force-recreate
 
 .PHONY: down
 down: ## Stop all containers.
-	docker compose down
+	$(COMPOSE) down
 
 .PHONY: revision
 revision: ## Create a new database revision following the repository's models.
@@ -38,13 +41,13 @@ migrate: ## Run database migrations.
 downgrade: ## Undo last database migration.
 	poetry run alembic downgrade -1
 
-.PHONY: docker-rm
-docker-rm: ## Remove all docker containers.
-	docker rm -f $$(docker ps -a -q)
+.PHONY: remove-containers
+remove-containers: ## Remove all containers.
+	$(CONTAINER_ENGINE) rm -f $$($(CONTAINER_ENGINE) ps -a -q)
 
-.PHONY: docker-rmi
-docker-rmi: ## Remove all downloaded docker images.
-	docker rmi -f $$(docker images -q)
+.PHONY: remove-container-images
+remove-container-images: ## Remove all downloaded container images.
+	$(CONTAINER_ENGINE) rmi -f $$($(CONTAINER_ENGINE) images -q)
 
 .PHONY: export-requirements
 export-requirements: ## Export poetry managed packages to a requirements.txt (needed by Vercel).
@@ -62,6 +65,10 @@ patch: ## Bump project version to next patch (bugfix release).
 minor: ## Bump project version to next minor (feature release).
 	poetry version minor
 
+.PHONY: major
+major: ## Bump project version to next major (breaking change).
+	poetry version major
+
 .PHONY: clean
 clean: ## Clean project's temporary files.
 	find . -name '__pycache__' -exec rm -rf {} +

README.md

@@ -113,13 +113,13 @@ make pre-commit
 
 For changes to the database, you can follow these steps:
 
-1. Make changes to the database models in `api/database/models`.
-2. Make sure new models are imported in `api/database/__init__.py`.
+1. Make changes to the database models in `src/database/models`.
+2. Make sure new models are imported in `src/database/__init__.py`.
 3. Create a new revision:
    ```bash
    make revision
    ```
-4. Check the new revision file created in `api/database/alembic/versions` and make sure it reflects the changes you expect.
+4. Check the new revision file created in `src/database/alembic/versions` and make sure it reflects the changes you expect.
 5. Apply the migration to your database (the database needs to be running and available):
    ```bash
    make migrate

alembic.ini

@@ -3,7 +3,7 @@
 [alembic]
 # path to migration scripts
 # Use forward slashes (/) also on windows to provide an os agnostic path
-script_location = api/database/alembic
+script_location = src/database/alembic
 
 # template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
 # Uncomment the line below if you want the files to be prepended with date and time