initial

Author: BrainIsDead

.env.example

@@ -0,0 +1,11 @@
+POSTGRES_DB=postgres_db_name
+POSTGRES_USER=postgres_db_user
+POSTGRES_PASSWORD=postgres_db_password
+POSTGRES_PORT=postgres_db_port
+
+ALLOWED_HOSTS='127.0.0.1,localhost'
+CORS_ORIGIN_WHITELIST='http://127.0.0.1:3000,http://localhost:3000'
+CSRF_TRUSTED_ORIGINS='http://127.0.0.1:8000,http://localhost:8000'
+
+SECRET_KEY='secret_key'
+DEBUG='True'

.flake8

@@ -0,0 +1,9 @@
+[flake8]
+max-line-length = 158
+max-complexity = 10
+exclude =
+    .git,
+    __pycache__,
+    .env,
+    venv,
+    */migrations

.gitignore

@@ -0,0 +1,11 @@
+.env
+/.vscode/
+/src/media/
+/src/static/
+*.mo
+*.pyc
+htmlcov/
+.coverage
+.coverage.*
+coverage.xml
+*.cover

.isort.cfg

@@ -0,0 +1,5 @@
+[settings]
+multi_line_output=3
+force_grid_wrap = 3
+include_trailing_comma=True
+line_length=158

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+        always_run: false
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: flake8
+        exclude: (migrations)

Dockerfile

@@ -0,0 +1,15 @@
+FROM python:3.10.8-alpine
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+RUN addgroup -S python && adduser -S python -G python
+RUN pip install -U pipenv
+USER python
+WORKDIR /home/python
+COPY --chown=python:python Pipfile Pipfile.lock ./
+RUN pipenv install --system --deploy
+COPY --chown=python:python /src .
+COPY --chown=python:python /gunicorn/gunicorn.py .
+ENV PATH="/home/python/.local/bin:${PATH}"
+EXPOSE 8000
+CMD ["gunicorn", "signal_documentation.wsgi:application", "-c", "gunicorn.py"]

Pipfile

@@ -0,0 +1,26 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+django = "*"
+django-filter = "*"
+psycopg2-binary = "*"
+django-extensions = "*"
+pillow = "*"
+pre-commit = "*"
+sentry-sdk = "*"
+python-dotenv = "*"
+django-health-check = "*"
+django-cors-headers = "*"
+django-debug-toolbar = "*"
+gunicorn = "*"
+
+[dev-packages]
+flake8 = "*"
+isort = "*"
+pep8 = "*"
+
+[requires]
+python_version = "3.10"

Pipfile.lock

@@ -0,0 +1,51 @@
+# Signal Documentation
+Single Source of Documentation System
+
+## Core libs and DB
+1. [Django](https://www.djangoproject.com/)
+2. [Django-filter](https://django-filter.readthedocs.io/en/stable/index.html)
+3. [PostgreSQL](https://www.postgresql.org/)
+
+
+All requirements you can find in `Pipfile`
+
+## Getting started
+
+### Setup Env Vars
+
+create `.env` file and add variables like in `.env.example`
+
+### To run locally
+
+Install `python:3.10`, `pip3`, `pipenv`
+
+Using [pipenv](https://github.com/pypa/pipenv) run `pipenv shell` and `pipenv install` to create virtual environment and install dependencies
+
+```sh
+$ pipenv shell
+$ pipenv install
+```
+
+Go to `src` directory and run
+
+```sh
+$ python manage.py migrate
+$ python manage.py test
+$ python manage.py runserver
+```
+
+### To run via docker
+
+Install `Docker` and `docker-compose`
+
+Run
+```sh
+$ docker-compose build
+$ docker-compose up
+
+```
+
+Open `http://localhost:8000` to view it in the browser
+
+## [Django admin](https://docs.djangoproject.com/en/4.1/ref/contrib/admin/) web interface (user should be `is_staff` or `is_superuser`)
+`http://localhost:8000/admin`

README.md

@@ -0,0 +1,38 @@
+version: '3.8'
+
+services:
+
+  db:
+    image: postgres:latest
+    container_name: signal_documentation-db
+    restart: always
+    env_file:
+     - ./.env
+    environment:
+      POSTGRES_DB: ${POSTGRES_DB}
+      POSTGRES_USER: ${POSTGRES_USER}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+      POSTGRES_HOST: ${POSTGRES_HOST}
+    volumes:
+      - postgres:/var/lib/postgresql/data
+    ports:
+      - "5432:5432"
+
+  webapp:
+    build: .
+    env_file:
+     - ./.env
+    container_name: signal_documentation-web
+    command: sh -c "python /usr/src/signal_documentation/src/manage.py migrate --noinput &&
+                    python /usr/src/signal_documentation/src/manage.py collectstatic --noinput &&
+                    python /usr/src/signal_documentation/src/manage.py runserver 0.0.0.0:8000"
+    volumes:
+      - .:/usr/src/signal_documentation
+    ports:
+      - "8000:8000"
+    depends_on:
+      - db
+
+volumes:
+  postgres:
+  webapp:

docker-compose.yaml

@@ -0,0 +1,4 @@
+import multiprocessing
+
+bind = "0.0.0.0:8000"
+workers = multiprocessing.cpu_count() * 2 + 1

gunicorn/gunicorn.py

@@ -0,0 +1,3 @@
+FROM nginx:1.23
+
+COPY default.conf.template /etc/nginx/templates/default.conf.template

nginx/Dockerfile

@@ -0,0 +1,16 @@
+server {
+	listen 80;
+	server_name _;
+
+	location / {
+		proxy_set_header Host $http_host;
+		proxy_set_header X-Real-IP $remote_addr;
+		proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+		proxy_set_header X-Forwarded-Proto $scheme;
+		proxy_pass http://${APP_HOST}:8000;
+	}
+
+	location /usr/src/signal_documentation {
+		alias /static/;
+	}
+}

nginx/default.conf.template

@@ -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', 'signal_documentation.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()

src/manage.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for signal_documentation 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', 'signal_documentation.settings')
+
+application = get_asgi_application()