Difference between revisions of "Django"

From Sinfronteras
Jump to: navigation, search
(→‎Setting the development environment)
Line 67: Line 67:
 
==Setting the development environment==
 
==Setting the development environment==
  
−
* '''Create «requirements.txt» in your project directory:'''
+
* '''requirements.txt:'''
 
<blockquote>
 
<blockquote>
 
<code>requirements.txt:</code>
 
<code>requirements.txt:</code>
Line 77: Line 77:
  
  
−
Dockerfile:
+
<br />
−
FROM python:3.9-alpine3.13
 
−
LABEL maintainer="adeloaleman"
 
  
−
ENV PYTHONUNBUFFERED 1
+
* '''Dockerfile:'''
−
COPY ./requirements.txt /tmp/requirements.txt
+
<blockquote>
−
COPY ./app /app
+
<syntaxhighlight lang="html">
−
WORKDIR /app
 
−
EXPOSE 8000
 
  
−
RUN python -m venv /py && \
+
</syntaxhighlight>
−
    /py/bin/pip install --upgrade pip && \
+
</blockquote>
−
    /py/bin/pip install -r /tmp/requirements.txt && \
 
−
    rm -rf /tmp && \
 
−
    adduser \
 
−
        --disabled-password
 
−
        --no-create-home \
 
−
        django-user
 
−
       
 
−
ENV PATH="/py/bin:$PATH"
 
  
−
USER django-user
 
  
 +
<br />
 +
* '''.dockerignore:'''
 +
<blockquote>
 +
<syntaxhighlight lang="html">
  
−
.dockerignore:
+
</syntaxhighlight>
−
# Git
+
</blockquote>
−
.git
 
−
.gitignore
 
  
−
# Docker
 
−
.docker
 
  
−
# Python
+
<br />
−
app/__pycache__/
+
* '''Then we create the app directory insde our project directory'''
−
app/*/__pycache__/
+
<blockquote>
−
app/*/*/__pycache__/
+
<syntaxhighlight lang="html">
−
app/*/*/*/__pycache__/
+
mkdir app
−
.env/
+
</syntaxhighlight>
−
.venv/
+
</blockquote>
−
venv/
 
  
  
−
Then we create the app directory insde our project directory
+
<br />
 +
* '''Then we run:'''
 +
<blockquote>
 +
docker build .
 +
<syntaxhighlight lang="html">
  
−
Then we run:
+
</syntaxhighlight>
−
docker build .
+
</blockquote>
  
  
−
Then we create our docker-compose.yml:
+
<br />
−
version: "3.9"
+
* '''docker-compose.yml'''
 +
<blockquote>
 +
<syntaxhighlight lang="html">
  
−
services:
+
</syntaxhighlight>
−
  app:
+
</blockquote>
−
    build:
 
−
      context: .
 
−
    ports:
 
−
      - "8000:8000"
 
−
    volumes:
 
−
      - ./app:/app
 
−
    command: >
 
−
      sh -c "python manage.py runserver 0.0.0.0:8000"
 
  
  
−
Then we run in our project directory:
+
<br />
 +
* '''Then we run in our project directory:'''
 +
<blockquote>
 +
<syntaxhighlight lang="html">
 
docker-compose build
 
docker-compose build
 +
</syntaxhighlight>
 +
</blockquote>
  
  
−
...
+
<br />
−
...
+
* '''...:'''
−
...
+
<blockquote>
−
 
+
<syntaxhighlight lang="html">
−
 
 
 
docker-compose run --rm app sh -c "flake8"
 
docker-compose run --rm app sh -c "flake8"
−
 
  
 
docker-compose run --rm app sh -c "django-admin startproject app ."
 
docker-compose run --rm app sh -c "django-admin startproject app ."
−
 
  
 
docker-compose up
 
docker-compose up
−
 
−
 
−
* ''' :'''
 
−
<blockquote>
 
−
<syntaxhighlight lang="html">
 
−
 
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</blockquote>
 
</blockquote>
  
  
−
* ''' :'''
+
<br />
−
<blockquote>
 
−
<syntaxhighlight lang="html">
 
−
 
 
−
</syntaxhighlight>
 
−
</blockquote>
 

Revision as of 14:28, 5 May 2023

https://www.djangoproject.com/



Recipe REST API - Udemy course

https://www.udemy.com/course/django-python-advanced/



API Features:

  • 19 API Endpoints
Managing users, recipes, tags, ingredients
  • User Authentication
  • Browseable Admin Interface (Django Admin)
  • Browsable API (Swagger)



Techologies used in this course:

  • Django allows handle: URL Mappings / Object Relational Mapper / Admin site
  • Django REST Framework: Django add-on / Build REST APIs
  • PostgresSQL
  • Docker
  • Git
  • Swagger: Documentation / Browsable API (testing)



Structure of the project:

  • app/ : Main app - Django project
  • app/core/ : Hangle any code shared between multiple apps. Such as the DB definition using the Django modules
  • app/user/ : User related code. Such as User registration & auth tokens
  • app/recipe/ : Recipe related code. Such as handling updating ingredients - Creating/Deleting/Udating recipes



Unit Tests and Test-driven development (TDD)

See explanation at https://www.udemy.com/course/django-python-advanced/learn/lecture/32238668#notes


  • Unit Tests: Code which test code:
It's usually done this way:
  • You Set up some conditions; such as inputs to a function
  • Then you run a piece of code
  • Checks outputs of that code using "assertions"


Test-driven development (TDD)

... pegar la imagen de la presentacion que tomé del curso ...



Docker

  • Define a Dockerfile: Contains all the OS level dependencies that our project needs.
  • Create a Docker Compose configuration: Tells Docker how to run the images that are created from our Docker file configuration.
  • Run all commands via Docker Compose.


  • Docker on GitHub Actions:
  • Docker Hub is where we can pull shared public images to reuse them for your project. For example there an image for Python, PostgreSQL, etc. Docker Hub has introduced rate limits.
  • Because of the rate limits, we have to Authenticate with Docker Hub: Create an account / Setup credentials / Login before running job.
  • https://hub.docker.com/


Setting the development environment

  • requirements.txt:

requirements.txt: 

Django>=3.2.4,<3.3
djangorestframework>=3.12.4,<3.13



  • Dockerfile:



  • .dockerignore:



  • Then we create the app directory insde our project directory
mkdir app



  • Then we run:

docker build .



  • docker-compose.yml



  • Then we run in our project directory:
docker-compose build



  • ...:
docker-compose run --rm app sh -c "flake8"

docker-compose run --rm app sh -c "django-admin startproject app ."

docker-compose up



Retrieved from "http://wiki.sinfronteras.ws/index.php?title=Django&oldid=24401"