Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Task1 #1

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
POSTGRES_USER=dbuser
POSTGRES_DB=task1
POSTGRES_PASSWORD=dbpasswd
POSTGRES_HOST=db
POSTGRES_PORT=5432
Comment on lines +1 to +5

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be .env.example, .env is meant to be in the start-ready environment.

4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ celerybeat.pid
*.sage.py

# Environments
.env
.venv
env/
venv/
Expand All @@ -127,3 +126,6 @@ dmypy.json

# Pyre type checker
.pyre/

/.idea
/docker_dev_data
20 changes: 20 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
FROM python:3-alpine
ENV PYTHONUNBUFFERED 1
RUN mkdir /code
WORKDIR /code
RUN apk add --no-cache make automake cmake gcc g++ subversion python3-dev libc-dev \
postgresql postgresql-dev
RUN pip install --upgrade pip
ADD requirements.txt /code/
RUN pip install -r requirements.txt

COPY docker-command.sh /code/
RUN chmod +x /code/docker-command.sh
COPY wait-for-pgdb.sh /code/
RUN chmod +x /code/wait-for-pgdb.sh
COPY backend /code/

#RUN apk add --no-cache libc6-compat

ENTRYPOINT ["/code/wait-for-pgdb.sh"]
CMD ["/code/docker-command.sh"]
48 changes: 47 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,48 @@
# CR_python1
Task 1

Реализовать простой сервис, который принимает и отвечает на HTTP-запросы
###Запуск в dev-окружении
Запуск develop-сервера

`docker-compose up`

Инициализация базы данных(применение миграций)

`docker-compose exec web python3 manage.py migrate`

Создание суперпользователя:

`docker-compose exec web python3 manage.py createsuperuser`

Для того чтобы авторизоваться нужно зайти на http://localhost:8000/admin

API находится на http://localhost:8000/api

Создание фейковых данных:

`docker-compose exec web python3 manage.py createmockdata`


Запуск тестов:

`docker-compose exec web python3 manage.py test --keepdb`

###Описание
####Функциональность
* Получение всех городов из базы данных (использовать mock-данные)
* Получение всех улиц города из базы данных (использовать mock-данные)
* Создать магазин с данными о городе, улице, графике работы (по дням и по часам) и примечание
* Получить магазин/(-ы) на основе фильтрации по одному или нескольким аттрибутов у сущности магазина (см. предыдущий пункт)

####Инструменты
* Python 3.6+
* Django 2.2+
* Django REST Framework
* Реляционная база данных (желательно – PostgreSQL)


####Условия
* Наличие README.md для описания проекта и способа его установки/запуска локально
* Работа с Docker будет большим плюсом
* Обратить внимание на проектирование таблиц базы данных. Вероятно, здесь будет не одна таблица и будут применимы внешние ключи (Foreign Key).

Empty file added backend/backend/__init__.py
Empty file.
15 changes: 15 additions & 0 deletions backend/backend/api_router.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
from django.conf import settings
from rest_framework.routers import DefaultRouter, SimpleRouter
from store.api import TownViewSet, StreetViewSet, StoreViewSet

if settings.DEBUG:
router = DefaultRouter()
else:
router = SimpleRouter()

router.register("town", TownViewSet)
router.register("street", StreetViewSet)
router.register("store", StoreViewSet)

app_name = "api"
urlpatterns = router.urls
16 changes: 16 additions & 0 deletions backend/backend/asgi.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
ASGI config for backend 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.0/howto/deployment/asgi/
"""

import os

from django.core.asgi import get_asgi_application

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'backend.settings')

application = get_asgi_application()
150 changes: 150 additions & 0 deletions backend/backend/settings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
"""
Django settings for backend project.

Generated by 'django-admin startproject' using Django 4.0.

For more information on this file, see
https://docs.djangoproject.com/en/4.0/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/4.0/ref/settings/
"""

from pathlib import Path
import os

# 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.0/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = 'django-insecure-_101p89468^yfmb3wl7*k@wim8k0_mx$w6t@@tq1iaz11_-&e&'

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

ALLOWED_HOSTS = []
Comment on lines +24 to +29

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These config params should be the environment variables, especially, SECRET_KEY



# Application definition

INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'store',
'rest_framework',
'django_filters',
]

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 = 'backend.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 = 'backend.wsgi.application'


# Database
# https://docs.djangoproject.com/en/4.0/ref/settings/#databases

DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': os.environ.get('POSTGRES_DB', 'db'),
'USER': os.environ.get('POSTGRES_USER', 'user'),
'PASSWORD': os.environ.get('POSTGRES_PASSWORD', '123456'),
'HOST': os.environ.get('POSTGRES_HOST', 'db'),
'PORT': int(os.environ.get('POSTGRES_PORT', '5432')),
}
}


# Password validation
# https://docs.djangoproject.com/en/4.0/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.0/topics/i18n/

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'Europe/Moscow'

USE_I18N = True

USE_L10N = True

USE_TZ = True


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/4.0/howto/static-files/

STATIC_URL = 'static/'

# Default primary key field type
# https://docs.djangoproject.com/en/4.0/ref/settings/#default-auto-field

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

REST_FRAMEWORK = {
# Use Django's standard `django.contrib.auth` permissions,
# or allow read-only access for unauthenticated users.
'DEFAULT_AUTHENTICATION_CLASSES': [
'rest_framework.authentication.TokenAuthentication',
'rest_framework.authentication.SessionAuthentication',
],
'DEFAULT_FILTER_BACKENDS': ['django_filters.rest_framework.DjangoFilterBackend'],
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.AcceptHeaderVersioning',
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.IsAuthenticated'
],
'PAGE_SIZE': 20,
'PAGE_SIZE_QUERY_PARAM':'page_size',
}
22 changes: 22 additions & 0 deletions backend/backend/urls.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
"""backend URL Configuration

The `urlpatterns` list routes URLs to views. For more information please see:
https://docs.djangoproject.com/en/4.0/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, include

urlpatterns = [
path('api/', include('backend.api_router')),
path('admin/', admin.site.urls),
]
16 changes: 16 additions & 0 deletions backend/backend/wsgi.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
WSGI config for backend 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.0/howto/deployment/wsgi/
"""

import os

from django.core.wsgi import get_wsgi_application

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'backend.settings')

application = get_wsgi_application()
22 changes: 22 additions & 0 deletions backend/manage.py
Original file line number Diff line number Diff line change
@@ -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', 'backend.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()
Empty file added backend/store/__init__.py
Empty file.
11 changes: 11 additions & 0 deletions backend/store/admin.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
from django.contrib import admin

# Register your models here.

from .models import Store, Street, Schedule, Town


admin.site.register(Town, admin.ModelAdmin)
admin.site.register(Street, admin.ModelAdmin)
admin.site.register(Schedule, admin.ModelAdmin)
admin.site.register(Store, admin.ModelAdmin)
34 changes: 34 additions & 0 deletions backend/store/api.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
from rest_framework import viewsets
import django_filters
from django_filters.rest_framework import DjangoFilterBackend, FilterSet
from .models import Town, Street, Store
from .serializers import TownSerializer, StreetSerializer, StoreSerializer


class TownViewSet(viewsets.ModelViewSet):
queryset = Town.objects.all()
serializer_class = TownSerializer


class StreetViewSet(viewsets.ModelViewSet):
queryset = Street.objects.all()
serializer_class = StreetSerializer


class StoreFilter(FilterSet):
Name = django_filters.CharFilter(field_name='Name', lookup_expr='icontains')
Comment = django_filters.CharFilter(field_name='Comment', lookup_expr='icontains')
Town = django_filters.CharFilter(field_name='Street__Town__Name', lookup_expr='icontains')
Street = django_filters.CharFilter(field_name='Street__Name', lookup_expr='icontains')
Number = django_filters.CharFilter(field_name='Number', lookup_expr='icontains')

class Meta:
model = Store
fields = ['Name', 'Comment', 'Town', 'Street', 'Number']


class StoreViewSet(viewsets.ModelViewSet):
queryset = Store.objects.all()
serializer_class = StoreSerializer
filter_backends = [DjangoFilterBackend]
filter_class = StoreFilter
6 changes: 6 additions & 0 deletions backend/store/apps.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
from django.apps import AppConfig


class StoreConfig(AppConfig):
default_auto_field = 'django.db.models.BigAutoField'
name = 'store'
Empty file.
Empty file.
Loading