Upstream changes

.github/workflows/django.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.9, '3.10']
+        python-version: ['3.9', '3.10']
 
     steps:
     - uses: actions/checkout@v2
@@ -33,7 +33,7 @@ jobs:
       run: |
         coverage run manage.py test --settings=config.settings.tests
       env:
-        OAUTH_OSM_KEY: ${{ secrets.OAUTH_OSM_KEY }}
-        OAUTH_OSM_SECRET: ${{ secrets.OAUTH_OSM_SECRET }}
-        POSTGRES_USER: ${{ secrets.POSTGRES_USER }}
-        POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
+        OAUTH2_OSM_KEY: ${{ secrets.OAUTH_OSM_KEY }}
+        OAUTH2_OSM_SECRET: ${{ secrets.OAUTH_OSM_SECRET }}
+        PGUSER: ${{ secrets.POSTGRES_USER }}
+        PGPASSWORD: ${{ secrets.POSTGRES_PASSWORD }}

.github/workflows/docker-publish.yml

@@ -2,35 +2,55 @@ name: Build Docker Image, Push to GHCR
 
 on:
   push:
-    branches:
-    - master
-    - ohm
+    branches: [ "main" , "ohm", "upstream_main" ]
+    tags: [ 'v*.*.*' ]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: openhistoricalmap/osmcha-django
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
+
+    - name: Get Git Commit SHA
+      run: echo "GIT_SHA=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
 
+    # Enable BuildKit for docker builds. This enables building
+    # multi-platform images and exporting the layer cache
+    # https://github.com/docker/setup-buildx-action
     - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v1
+      uses: docker/setup-buildx-action@v3
 
-    - name: Login to GitHub Container Registry
-      uses: docker/login-action@v2
+    # https://github.com/docker/login-action
+    - name: Login to Registry ${{ env.REGISTRY }}
+      uses: docker/login-action@v3
       with:
-        registry: ghcr.io
+        registry: ${{ env.REGISTRY }}
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}
 
-    - name: Build and push Docker image
-      uses: docker/build-push-action@v4
+    # Extract metadata (tags, labels) for Docker
+    # https://github.com/docker/metadata-action
+    - name: Extract Docker metadata
+      id: meta
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+    # https://github.com/docker/build-push-action
+    - name: Build and push Docker image with Git SHA
+      uses: docker/build-push-action@v5
       with:
         context: .
         push: true
         tags: |
-          ghcr.io/osmcha/osmcha-django:latest
-          ghcr.io/osmcha/osmcha-django:${{ github.sha }}
+          ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
+          ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.GIT_SHA }}
+        labels: ${{ steps.meta.outputs.labels }}
         cache-from: type=gha
-        cache-to: type=gha,mode=max
+        cache-to: type=gha,mode=max

DEPLOY.rst

@@ -14,11 +14,6 @@ You can access your ``osmcha-django`` instance in http://localhost/ at your brow
 It is also possible to deploy to Heroku or to your own server by using Dokku, an open
 source Heroku clone.
 
-To put celery in production we need a celeryd and a celery beat services running on
-the machine. More information: https://celery.readthedocs.org/en/latest/tutorials/daemonizing.html#daemonizing
-
-And we also need to set periodic tasks to import the changesets daily or hourly: https://celery.readthedocs.org/en/latest/userguide/periodic-tasks.html
-
 If you find any issue, please report. We didn't test it in Heroku and Dokku
 
 Heroku

Dockerfile

@@ -1,5 +1,7 @@
 FROM python:3.10-slim-bookworm
 ARG DEBIAN_FRONTEND=noninteractive
+ARG REQUIREMENTS_FILE=production.txt
+ARG DJANGO_SETTINGS_MODULE=config.settings.production
 
 RUN apt-get update -qq -y \
     && apt-get install -y curl wget python3 python3-dev python3-pip git \
@@ -10,21 +12,24 @@ RUN apt-get update -qq -y \
 
 # Requirements have to be pulled and installed here, otherwise caching won't work
 COPY ./requirements /requirements
-
-RUN pip install -r /requirements/production.txt
+RUN pip install -r /requirements/$REQUIREMENTS_FILE
 
 COPY . /app
 RUN useradd django
 RUN chown -R django:django /app
+WORKDIR /app
+
+RUN python manage.py collectstatic --noinput
 
-COPY ./compose/django/gunicorn.sh /gunicorn.sh
 COPY ./compose/django/entrypoint.sh /entrypoint.sh
-RUN sed -i 's/\r//' /entrypoint.sh \
-    && sed -i 's/\r//' /gunicorn.sh \
-    && chmod +x /entrypoint.sh \
-    && chmod +x /gunicorn.sh
+RUN chmod +x /entrypoint.sh
 
-WORKDIR /app
 USER django
+VOLUME /app/staticfiles
+
+# Default number of gunicorn worker processes. Using an env var instead of --workers
+# in the command below lets users of this docker image override the default easily.
+ENV WEB_CONCURRENCY 4
 
 ENTRYPOINT ["/entrypoint.sh"]
+CMD ["gunicorn", "config.wsgi", "-t", "120", "-b", "0.0.0.0:5000", "--access-logfile", "-"]

README.rst

@@ -11,8 +11,8 @@ osmcha-django
 The aim of OSMCHA is to help identify and fix harmful edits in the OpenStreetMap.
 It relies on `OSMCHA <https://github.com/willemarcel/osmcha>`_ to analyse the changesets.
 
-This project provides a Django application that get the changesets from the
-OpenStreetMap API, analyses and store it in a database and finally provides a
+This project provides a Django application that gets changesets from the
+OpenStreetMap API, analyses and stores them in a database and finally provides a
 REST API to interact with the changeset data.
 
 This repository contains the backend code. You can report errors or request new features in the
@@ -30,7 +30,7 @@ Apache/mod_wsgi setups**. It has been deployed successfully with both Gunicorn/N
 and uWSGI/Nginx.
 
 For configuration purposes, the following table maps the 'osmcha-django' environment
-variables to their Django setting:
+variables to their Django settings:
 
 
 ======================================= ================================= ========================================= ===========================================
@@ -50,16 +50,15 @@ DJANGO_DEFAULT_FROM_EMAIL               DEFAULT_FROM_EMAIL                n/a
 DJANGO_SERVER_EMAIL                     SERVER_EMAIL                      n/a                                       "osmcha-django <[email protected]>"
 DJANGO_EMAIL_SUBJECT_PREFIX             EMAIL_SUBJECT_PREFIX              n/a                                       "[osmcha-django] "
 DJANGO_CHANGESETS_FILTER                CHANGESETS_FILTER                 None                                      None
-POSTGRES_USER                           POSTGRES_USER                     None                                      None
-POSTGRES_PASSWORD                       POSTGRES_PASSWORD                 None                                      None
-PGHOST                                  PGHOST                            localhost                                 localhost
-OAUTH_OSM_KEY                           SOCIAL_AUTH_OPENSTREETMAP_KEY     None                                      None
-OAUTH_OSM_SECRET                        SOCIAL_AUTH_OPENSTREETMAP_SECRET  None                                      None
+PGUSER                                  DATABASES                         None                                      None
+PGPASSWORD                              DATABASES                         None                                      None
+PGHOST                                  DATABASES                         localhost                                 localhost
+OAUTH2_OSM_KEY                          SOCIAL_AUTH_OPENSTREETMAP_KEY     None                                      None
+OAUTH2_OSM_SECRET                       SOCIAL_AUTH_OPENSTREETMAP_SECRET  None                                      None
 DJANGO_ANON_USER_THROTTLE_RATE          ANON_USER_THROTTLE_RATE           None                                      30/min
 DJANGO_COMMON_USER_THROTTLE_RATE        COMMON_USER_THROTTLE_RATE         None                                      180/min
 DJANGO_NON_STAFF_USER_THROTTLE_RATE     NON_STAFF_USER_THROTTLE_RATE      3/min                                     3/min
 OAUTH_REDIRECT_URI                      OAUTH_REDIRECT_URI                http://localhost:8000/oauth-landing.html  http://localhost:8000/oauth-landing.html
-OSMCHA_FRONTEND_VERSION                 OSMCHA_FRONTEND_VERSION           oh-pages                                  oh-pages
 DJANGO_ENABLE_CHANGESET_COMMENTS        ENABLE_POST_CHANGESET_COMMENTS    False                                     False
 DJANGO_OSM_COMMENTS_API_KEY             OSM_COMMENTS_API_KEY              ''                                        ''
 ======================================= ================================= ========================================= ===========================================
@@ -91,7 +90,7 @@ We assume you have the following installed:
 * virtualenv
 * PostgreSQL
 
-Before to install the python libraries, we need to install some packages in the
+Before installing the python libraries, we need to install some packages in the
 operational system::
 
     $ sudo ./install_os_dependencies.sh install
@@ -122,7 +121,7 @@ Setting Up Your Users
 
 To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.
 
-To create an **superuser account**, use this command::
+To create a **superuser account**, use this command::
 
     $ python manage.py createsuperuser
 
@@ -140,30 +139,24 @@ How to login using the OAuth api
 Frontend
 ^^^^^^^^
 
-`osmcha-frontend <https://github.com/osmcha/osmcha-frontend>`_ is a web interface
-that you can use to interact with the API. We have a django management command
-to get the last version of osmcha-frontend and serve it with the API.
-
-    $ python manage.py update_frontend
-
-After that, if you have set all the environment variables properly, you can start
-the server and have the frontend in your root url.
+`osmcha-frontend <https://github.com/osmcha/osmcha-frontend>`_ is a web
+interface that you can use to interact with the API. The web interface can be
+deployed separately and configured to talk to this Django app when making API
+requests. See the README in that repository for more details.
 
 Feature creation endpoint
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The feature creation endpoint allows only admin users to create features. You can
-use the admin site to create a token to a user.
+use the admin site to create a token for a user.
 
 Instances
 ---------
 
-We have some instances running ``osmcha-django``:
-
 The main instance is https://osmcha.org/. You can check the API
 documentation at https://osmcha.org/api-docs/.
 
-Furthermore, we have a test instance running at http://osmcha-org-staging.osmcha.org/.
+There is currently no official staging instance.
 
 Deployment
 ------------
@@ -174,7 +167,7 @@ Check the `Deploy <DEPLOY.rst>`_ file for instructions on how to deploy with Her
 Get in contact
 ---------------
 
-If you use, deploy or are interested in help to develop OSMCha, subscribe to our
+If you use, deploy or are interested in helping develop OSMCha, subscribe to our
 `mailing list <https://lists.openstreetmap.org/listinfo/osmcha-dev>`_. You can
 report errors or request new features in the
 `osmcha-frontend repository <https://github.com/osmcha/osmcha-frontend>`_.

compose/django/entrypoint.sh

@@ -1,35 +1,12 @@
-#!/bin/bash
+#!/bin/sh
 set -e
-cmd="$@"
 
-# This entrypoint is used to play nicely with the current cookiecutter configuration.
-# Since docker-compose relies heavily on environment variables itself for configuration, we'd have to define multiple
-# environment variables just to support cookiecutter out of the box. That makes no sense, so this little entrypoint
-# does all this for us.
-export REDIS_URL=redis://redis:6379
-# the official postgres image uses 'postgres' as default user if not set explictly.
-if [ -z "$POSTGRES_USER" ]; then
-    export POSTGRES_USER=postgres
-fi
-
-if [ -z "$POSTGRES_HOST" ]; then
-    export POSTGRES_HOST=postgres
-fi
-
-export PGHOST=$POSTGRES_HOST
-export POSTGRES_USER=$POSTGRES_USER
-export POSTGRES_PASSWORD=$POSTGRES_PASSWORD
-# export DATABASE_URL=postgres://$POSTGRES_USER:$POSTGRES_PASSWORD@postgres:5432/$POSTGRES_USER
-
-export CELERY_BROKER_URL=$REDIS_URL/0
-
-
-function postgres_ready(){
+postgres_ready() {
 python << END
 import sys
 import psycopg2
 try:
-    conn = psycopg2.connect(dbname="$POSTGRES_USER", user="$POSTGRES_USER", password="$POSTGRES_PASSWORD", host="$POSTGRES_HOST")
+    conn = psycopg2.connect("") # use environment variables for connection
 except psycopg2.OperationalError:
     sys.exit(-1)
 sys.exit(0)
@@ -42,4 +19,4 @@ until postgres_ready; do
 done
 
 >&2 echo "Postgres is up - continuing..."
-exec $cmd
+exec $@

compose/django/start-dev.sh

@@ -1,3 +1,3 @@
 #!/bin/sh
 python manage.py migrate
-python manage.py runserver_plus 0.0.0.0:8000
+python manage.py runserver_plus 0.0.0.0:5000

config/__init__.py

@@ -1,7 +0,0 @@
-from __future__ import absolute_import
-
-# This will make sure the app is always imported when
-# Django starts so that shared_task will use this app.
-from .celery import app as celery_app  # noqa
-
-__all__ = ['celery_app']