init app recipies api

.dockerignore

@@ -0,0 +1,18 @@
+# Git
+.git
+.gitignore
+
+# Docker
+.docker
+
+# Python
+app/__pycache__/
+app/*/__pycache__/
+app/*/*/__pycache__/
+app/*/*/*/__pycache__/
+.env/
+.venv/
+venv/
+
+# Bash
+bash.session

.github/workflows/checks.yml

@@ -0,0 +1,21 @@
+---
+name: Checks
+
+on: [push]
+
+jobs:
+  test-lint:
+    name: Test and Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USER }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Test
+        run: docker compose run --rm app sh -c "python manage.py test"
+      - name: Lint
+        run: docker compose run --rm app sh -c "flake8"

.gitignore

@@ -0,0 +1,156 @@
+# temporary ignore
+bash.session
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

Dockerfile

@@ -0,0 +1,27 @@
+FROM python:3.12.0-slim-bookworm
+LABEL maintainer="devfzn@gmail.com"
+
+ENV PYTHONUNBUFFERED 1
+
+COPY ./requirements.txt /tmp/requirements.txt
+COPY ./requirements.dev.txt /tmp/requirements.dev.txt
+COPY ./app /app
+WORKDIR /app
+EXPOSE 8000
+
+ARG DEV=false
+RUN python -m venv /py && \
+    /py/bin/pip install --upgrade pip && \
+    /py/bin/pip install -r /tmp/requirements.txt && \
+    if [ $DEV = "true" ]; \
+        then /py/bin/pip install -r /tmp/requirements.dev.txt ; \
+    fi && \
+    rm -rf /tmp && \
+    adduser \
+        --disabled-password \
+        --no-create-home \
+        django-user
+
+ENV PATH="/py/bin:$PATH"
+
+USER django-user

README.md

@@ -0,0 +1,228 @@
+# REST API Django
+
+<style>div.mermaid{text-align: center;}</style>
+
+
+## Tecnologias
+
+- [Python](https://docs.python.org/3/) 3.12.0
+- [Django](https://docs.djangoproject.com/en/4.2/) 4.2.5
+- [Django REST Framework](https://www.django-rest-framework.org/) 3.14
+- [Django REST Swagger](https://django-rest-swagger.readthedocs.io/en/latest/)
+- [Docker](https://docs.docker.com/) 24.0.6 y
+*([Docker-compose](https://docs.docker.com/compose/)* incluido con docker cli)
+- [PostgreSQL](https://www.postgresql.org/about/)
+- Git
+- GitHub Actions
+
+```mermaid
+%%{init: {'theme': 'dark','themeVariables': {'clusterBkg': '#2b2f38'}, 'flowchart': {'curve': 'basis'}}}%%
+flowchart
+subgraph " "
+direction TB
+SW{Swagger-UI}
+
+subgraph APP["App Container"]
+RF("REST Framework")
+DJ("Django")
+PY("Python")
+end
+
+subgraph DBC["DB Container"]
+DB[(PostgreSQL)]
+end
+
+RF <--> SW
+RF <--> DJ <--> PY
+DB <--> DJ
+end
+```
+
+## Estructura del proyecto
+
+- `app` *Django project*
+- `app/core/` *código compartido entre multiples apps*
+- `app/user/` *código relativo al usuario*
+- `app/recipe/` *código relativo a las recetas*
+
+## TDD
+
+**T**est **D**riven **D**eveloment
+
+```mermaid
+%%{init: {'theme': 'dark','themeVariables': {'clusterBkg': '#2b2f38'}, 'flowchart': {'curve': 'natural'}}}%%
+flowchart
+subgraph " "
+direction LR
+WT[Write Test]
+RTF["Run Test
+(Fails)"]
+AF[Add Feature]
+RTP["Run Test
+(Passes)"]
+RF[Refactor]
+end
+WT --> RTF --> AF --> RTP --> RF
+RF --> RTP
+```
+
+- Esto proporciona un mejor entendimiento del código
+- Permite realizar cambios con confianza
+- Reduco *bugs*
+
+### Unitests
+
+- Código que prueba código
+  - Establecer condiciones/entradas
+  - Correr fragmentos de código
+  - Verificar salidas con `assertions`
+- Beneficios
+  - Asegurar que el código corre como se espera
+  - Atrapar *bugs*
+  - Mejorar fiabilidad
+  - Proporciona confianza
+
+## Docker
+
+### ¿Por qué usar Docker?
+
+- Consistencia entre ambientes de desarrollo y producción
+- Facilita la colaboración entre desarrolladores
+- Todas las dependencias como código
+  - Requerimientos de Python
+  - Dependencias del S.O.
+- Facilidad para limpiar el sistema (post-dev)
+- Ahorro de tiempo
+
+### ¿Como usar Docker?
+
+- Crear **dockerfile**
+- Crear docker **compose** configuration
+- Correr todos los comandos usando Docker **compose**
+
+#### Docker con GitHub Actions
+
+- Docker Hub tiene un limite de acceso:
+  - 100 pulls/6 hr para usuarios sin authentificación
+  - 200 pulls/6 hr para usuarios con authentificación
+- GitHub Actions es un servicio compartido
+  - 100 pulls/6 hr considera TODOS los usuarios
+- Autenticación con Docker Hub
+  - Crear cuenta
+  - Configurar credenciales
+  - Login antes de correr un trabajo (job)
+  - Obtener 200 pulls/6 hr gratis
+
+
+### Configurar Docker
+
+- Creación dockerfile
+- Lista de pasos para crear imagen
+  - Escoger una imagen basada en python
+  - Instalar dependencias
+  - Establecer usuarios
+
+#### Docker Compose
+
+- Como se debe utlizar la imagen de docker
+- Definir servicios
+  - Nombre (ej. app)
+  - Mapeo de puertos
+  - Mapeo de volumenes
+- Correr todos los comandos a travez de Docker Compose  
+ej. `docker-compose run --rm app sh -c "python manage.py collectstatic"`
+  - `docker-compose` Ejecuta un comando de Docker Compose
+  - `run` comienza un contenedor específico definido en la configuración
+  - `--rm` remueve el contenedor
+  - `app` es el nombre del servicio/applicación
+  - `sh -c` pasa una orden a la shell del container
+  - `"python manage.py ..."` comando a correr dentro del contenedor
+
+<br>
+
+- [Dockerfile](./Dockerfile)
+- [.dockerignore](./.dockerignore)
+
+```sh
+docker build .
+```
+
+- [docker-compose.yml](./docker-compose.yml)
+
+```sh
+docker-compose build
+```
+
+### Linting
+
+- Instalar `flake8`
+- [requirements.dev.txt](./requirements.dev.txt)
+- Configuración [flake8](./app/.flake8)
+- Correr a travez de docker-compose `docker-compose run --rm app sh -c "flake8"`
+
+### Testing
+
+- Django test suite
+- Configurar test por cada applicación Django
+- Correr a travez de docker-compose `docker-compose run --rm app sh -c "python
+manage.py test"`
+
+### Creación del proyecto Django
+
+```sh
+docker-compose run -rm app sh -c "django-admin startproject app ."
+```
+
+### Iniciar el servidor
+
+```sh
+docker-compose up
+```
+
+### GitHub Actions
+
+- Herramienta de automatización
+- Similar a Travis-CI, GitLab CI/CD, Jenkins
+- Ejecuta tareaas cunado el código cambia
+- Tareas automatizadas comunes:
+  - Despliege/implementación
+  - Code Linting
+  - Tests Unitarios
+
+Funciona con **Trigger** ej. `push` to GitHub
+
+#### ¿Como funciona?
+
+```mermaid
+%%{init: {'theme': 'dark','themeVariables': {'clusterBkg': '#2b2f38'}, 'flowchart': {'curve': 'natural'}}}%%
+flowchart
+subgraph " "
+direction LR
+TG["<b>Trigger</b>
+Push to GitHub"]
+JB["<b>Job</b>
+Run unit tests"]
+RS["<b>Result</b>
+Success/fail"]
+end
+TG ==> JB ==> RS
+```
+
+#### Costo
+
+- Se cobra por minutos de uso
+- 2.000 minutos *gratis*
+
+#### Configranción GitHub Actions
+
+- Creación de archivo [`checks.yml`](./.github/workflows/checks.yml)
+  - Set Trigger
+  - Añadir passos para correr pruebas y linting
+- Configurar DockerHub auth
+  - Necesitado para *jalar* imagenes base
+  - Limites:
+    - Anónimos: 100/6h
+    - Atentificado 200/6h
+  - GitHub Actions usan IP compartida, la limitación aplica para todos los usuarios
+  al autenticar con DockerHub se obtienen 200/6h de uso exclusivo
+

app/.flake8

@@ -0,0 +1,6 @@
+[flake8]
+exclude = 
+    migrations,
+    __pycache__,
+    manage.py,
+    settings.py

app/app/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for app project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'app.settings')
+
+application = get_asgi_application()

app/app/settings.py

@@ -0,0 +1,123 @@
+"""
+Django settings for app project.
+
+Generated by 'django-admin startproject' using Django 4.2.5.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.2/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-m()g8$#4fd-^v0_+4o-=4$6d1^g8=bj0t76c=b)*n_4=b%()&3'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = [ '192.168.1.10', '127.0.0.1' ]
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'app.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'app.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/4.2/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/4.2/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.2/howto/static-files/
+
+STATIC_URL = 'static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

app/app/urls.py

@@ -0,0 +1,22 @@
+"""
+URL configuration for app project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+]

app/app/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for app project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'app.settings')
+
+application = get_wsgi_application()

app/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'app.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

docker-compose.yml

@@ -0,0 +1,12 @@
+services:
+  app:
+    build:
+      context: .
+      args:
+        - DEV=true
+    ports:
+      - "8000:8000"
+    volumes:
+      - ./app:/app
+    command: >
+      sh -c "python manage.py runserver 0.0.0.0:8000"

requirements.dev.txt

@@ -0,0 +1 @@
+flake8>=6.0.0

requirements.txt

@@ -0,0 +1,2 @@
+Django>=4.2.5<4.3
+djangorestframework==3.14.0