Merge pull request #44 from City-of-Helsinki/release/0.1.0

Release 0.1.0

Author: tuomas777

.gitignore

@@ -0,0 +1,80 @@
+*$py.class
+*,cover
+*.egg
+*.egg-info/
+*.log
+*.manifest
+*.mo
+*.pid
+*.pot
+*.py[cod]
+*.pyc
+*.seed
+*.so
+*.spec
+*.stTheme.cache
+*.sublime-workspace
+*.tmlanguage.cache
+*.tmPreferences.cache
+._*
+.AppleDouble
+.cache
+.coverage
+.coverage.*
+.DS_Store
+.eggs/
+.env
+.grunt
+.hypothesis/
+.idea
+.installed.cfg
+.ipynb_checkpoints
+.lock-wscript
+.LSOverride
+.node_repl_history
+.npm
+.nyc_output
+.Python
+.python-version
+.ropeproject
+.scrapy
+.spyderproject
+.tox/
+__pycache__/
+_build
+bower_components
+build/
+build/Release
+celerybeat-schedule
+coverage
+coverage.xml
+develop-eggs/
+dist/
+docs/_build/
+downloads/
+eggs/
+env/
+ENV/
+htmlcov/
+instance/
+jspm_packages
+lib-cov
+lib//Users/tuomas/.pyenv/shims/python
+lib64/
+local_settings.py
+logs
+node_modules
+nosetests.xml
+npm-debug.log*
+parts/
+pids
+pip-delete-this-directory.txt
+pip-log.txt
+repo_name
+sdist/
+sftp-config.json
+target/
+var/
+venv/
+.pytest_cache/
+docker-compose.env.yaml

.gitlab-ci.yml

@@ -0,0 +1,36 @@
+# Mandatory include
+include:
+  - project: 'city-of-helsinki/kuva/ci-cd-config/ci-configuration'
+    ref: v2
+    file: '/.gitlab-ci-template.yml'
+
+# These variables are available for all stages
+variables:
+  APP_MIGRATE_COMMAND: /app/.prod/on_deploy.sh
+  SERVICE_PORT: "8000"
+
+# Build stage must be included and it must extend .build.
+build:
+  extends: .build
+
+review:
+  # These variables are available only for review env and are merged with the general variables defined above.
+  variables:
+    K8S_SECRET_ALLOWED_HOSTS: "*"
+    K8S_SECRET_DEBUG: 1
+    K8S_SECRET_TOKEN_AUTH_AUTHSERVER_URL: "https://tunnistamo.test.kuva.hel.ninja/openid"
+    K8S_SECRET_CORS_ORIGIN_ALLOW_ALL: 1
+
+staging:
+  # By default the staging environment is created from the master-branch.
+  # Here we define that it should be created from the branch called "develop" instead.
+  only:
+    refs:
+      - develop
+  # These variables are available only for staging env and are merged with the general variables defined above.
+  variables:
+    K8S_SECRET_ALLOWED_HOSTS: "*"
+    K8S_SECRET_CORS_ORIGIN_ALLOW_ALL: 1
+    K8S_SECRET_SECRET_KEY: "$GL_QA_DJANGO_SECRET_KEY"
+    K8S_SECRET_SKIP_DATABASE_CHECK: 1
+    K8S_SECRET_TOKEN_AUTH_AUTHSERVER_URL: "https://tunnistamo.test.kuva.hel.ninja/openid"

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v4.3.21
+    hooks:
+      - id: isort
+  - repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+      - id: black
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.7.9
+    hooks:
+      - id: flake8
+        exclude: migrations|snapshots

.prod/on_deploy.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+./manage.py migrate --noinput

.prod/uwsgi.ini

@@ -0,0 +1,10 @@
+[uwsgi]
+http-socket = :8000
+chdir = /app
+module = kukkuu.wsgi
+static-map = /static=/var/static
+uid = appuser
+gid = appuser
+master = 1
+processes = 2
+threads = 2

.travis.yml

@@ -0,0 +1,28 @@
+branches: {only: [master, develop]}
+sudo: false
+language: python
+python: 3.7
+cache: pip
+
+addons:
+  postgresql: "10"
+  apt:
+    packages:
+    - postgresql-10
+    - postgresql-client-10
+
+matrix:
+  include:
+    - name: Unit tests
+      env: DATABASE_URL=postgres:///kukkuu SECRET_KEY=topsecret123
+      services: [postgresql]
+      install: pip install -r requirements.txt -r requirements-dev.txt
+      script: pytest -ra -vv --doctest-modules --cov=.
+      after_success: pip install codecov && codecov
+
+    - name: Style
+      install: pip install -r requirements.txt -r requirements-dev.txt
+      script:
+        - black --check .
+        - flake8
+        - isort -c

Dockerfile

@@ -0,0 +1,48 @@
+# ==============================
+FROM helsinkitest/python:3.7-slim as appbase
+# ==============================
+RUN mkdir /entrypoint
+
+COPY --chown=appuser:appuser requirements.txt /app/requirements.txt
+COPY --chown=appuser:appuser requirements-prod.txt /app/requirements-prod.txt
+
+RUN apt-install.sh \
+        git \
+        netcat \
+        libpq-dev \
+        build-essential \
+    && pip install -U pip \
+    && pip install --no-cache-dir -r /app/requirements.txt \
+    && pip install --no-cache-dir  -r /app/requirements-prod.txt \
+    && apt-cleanup.sh build-essential
+
+COPY --chown=appuser:appuser docker-entrypoint.sh /entrypoint/docker-entrypoint.sh
+ENTRYPOINT ["/entrypoint/docker-entrypoint.sh"]
+
+# ==============================
+FROM appbase as development
+# ==============================
+
+COPY --chown=appuser:appuser requirements-dev.txt /app/requirements-dev.txt
+RUN apt-install.sh \
+        build-essential \
+    && pip install --no-cache-dir -r /app/requirements-dev.txt \
+    && apt-cleanup.sh build-essential
+
+ENV DEV_SERVER=1
+
+COPY --chown=appuser:appuser . /app/
+
+USER appuser
+EXPOSE 8081/tcp
+
+# ==============================
+FROM appbase as production
+# ==============================
+
+COPY --chown=appuser:appuser . /app/
+
+RUN SECRET_KEY="only-used-for-collectstatic" python manage.py collectstatic
+
+USER appuser
+EXPOSE 8000/tcp

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019, City of Helsinki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,84 @@
-# kukkuu
-Godchildren of culture API
+# Kukkuu
+
+:baby: Godchildren of culture (kulttuurin kummilapset) API :violin:
+
+## Development with Docker
+
+1. Copy `docker-compose.env.yaml.example` to `docker-compose.env.yaml` and modify it if needed.
+
+2. Run `docker-compose up`
+
+The project is now running at [localhost:8081](http://localhost:8081)
+
+## Development without Docker
+
+Prerequisites:
+
+* PostgreSQL 10
+* Python 3.7
+
+### Installing Python requirements
+
+* Run `pip install -r requirements.txt`
+* Run `pip install -r requirements-dev.txt` (development requirements)
+
+### Database
+
+To setup a database compatible with default database settings:
+
+Create user and database
+
+    sudo -u postgres createuser -P -R -S kukkuu  # use password `kukkuu`
+    sudo -u postgres createdb -O kukkuu kukkuu
+
+Allow user to create test database
+
+    sudo -u postgres psql -c "ALTER USER kukkuu CREATEDB;"
+
+### Daily running
+
+* Create `.env` file: `touch .env`
+* Set the `DEBUG` environment variable to `1`.
+* Run `python manage.py migrate`
+* Run `python manage.py runserver localhost:8081`
+
+The project is now running at [localhost:8081](http://localhost:8081)
+
+## Keeping Python requirements up to date
+
+1. Install `pip-tools`:
+
+    * `pip install pip-tools`
+
+2. Add new packages to `requirements.in` or `requirements-dev.in`
+
+3. Update `.txt` file for the changed requirements file:
+
+    * `pip-compile requirements.in`
+    * `pip-compile requirements-dev.in`
+
+4. If you want to update dependencies to their newest versions, run:
+
+    * `pip-compile --upgrade requirements.in`
+
+5. To install Python requirements run:
+
+    * `pip-sync requirements.txt`
+
+## Code format
+
+This project uses [`black`](https://github.com/ambv/black) for Python code formatting.
+We follow the basic config, without any modifications. Basic `black` commands:
+
+* To let `black` do its magic: `black .`
+* To see which files `black` would change: `black --check .`
+
+Or you can use [`pre-commit`](https://pre-commit.com/) to quickly format your code before committing.
+
+
+1. Install `pre-commit` (there are many ways to do but let's use pip as an example:
+    * `pip install pre-commit`
+2. Set up git hooks from `.pre-commit-config.yaml`, run this command from project root:
+    * `pre-commit install`
+
+After that, formatting hooks will run against all changed files before committing

children/__init__.py

@@ -0,0 +1 @@
+default_app_config = "children.apps.ChildrenConfig"