Improve and document docker-compose development environment

Author: timthelion

.gitignore

@@ -7,7 +7,7 @@ dist/
 example/django-import-export-celery-import-change-summaries/
 example/django-import-export-celery-import-jobs/
 example/django-import-export-celery-export-jobs/
-pipenv/
+pyenv/
 django_import_export_celery.egg-info/
 db/
 .idea/

Dockerfile

@@ -1,5 +1,6 @@
 FROM python:3.7
 RUN pip3 install poetry celery
 RUN apt-get update ; apt-get install -yq python3-psycopg2 gdal-bin
-RUN useradd test
+ARG UID
+RUN useradd test --uid $UID
 RUN chsh test -s /bin/bash

Makefile

@@ -1,31 +1,8 @@
-VERSION = $(shell git describe --abbrev=0 --tags)
-REPO_FILES ?= git ls-files -z | xargs --null -I '{}' find '{}' -type f -print0
-REPO_TXT_FILES ?= git ls-files -z | xargs --null -I '{}' find '{}' -type f -print0 | egrep -zZv '(png|svg)$$'
+docker-compose: Dockerfile
+	mkdir -p pyenv
+	mkdir -p db
+	sudo docker-compose build --build-arg UID=$(shell id -u)
+	sudo docker-compose up -d web postgres
+	sudo docker exec -it django-import-export-celery_web_1 /proj/setup-dev-env.sh
+	sudo docker-compose down
 
-packages: clean
-	python3 setup.py bdist_wheel
-	git archive --format=tar.gz $(VERSION) > dist/django-import-export-celery-$(VERSION).tar.gz
-	cd dist ; gpg --detach-sign -a *.whl
-	cd dist ; gpg --detach-sign -a *.tar.gz
-
-deploy-pypi:
-	twine upload dist/*.whl
-	twine upload dist/*.whl.asc
-
-deploy: deploy-pypi
-	echo Deployed
-
-clean:
-	rm -r dist ; exit 0
-	rm -r django_import_export_celery.egg-info ; exit 0
-	rm -r build ; exit 0
-
-qa: qa-miscellaneous qa-https-everywhere
-
-qa-miscellaneous:
-	$(REPO_TXT_FILES) | grep -zZv 'setup.py$$' | xargs --null sed -i 's#LGPL\s*v3#LGPL-3.0#g;'
-
-qa-https-everywhere:
-	$(REPO_TXT_FILES) | xargs --null sed --regexp-extended --in-place 's#http(:\\?/\\?/)(momentjs\.com|overpass-turbo\.eu|www\.gnu\.org|stackoverflow\.com|(:?www\.)?openstreetmap\.(org|de)|nominatim\.openstreetmap\.org|taginfo\.openstreetmap\.org|wiki\.openstreetmap\.org|josm.openstreetmap.de|www.openstreetmap.org\\/copyright|github\.com|xkcd\.com|www\.heise\.de|www\.readthedocs\.org|askubuntu\.com|xpra\.org|docker\.com|linuxcontainers\.org|www\.ecma-international\.org|www\.w3\.org|example\.com|www\.example\.com)#https\1\2#g;'
-	$(REPO_TXT_FILES) | xargs --null sed -i 's#http://overpass-api\.de#https://overpass-api.de#g;'
-	$(REPO_TXT_FILES) | xargs --null sed --regexp-extended --in-place 's#http://(\w+\.wikipedia\.org)#https://\1#g;'

README.rst

@@ -149,6 +149,15 @@ Performing exports with celery
 
 6. Click on the link near the bottom of the page titled `Exported file`.
 
+For developers of this library
+------------------------------
+
+You can enter a preconfigured dev environment by first running `make` and then launching `./develop.sh` to get into a docker compose environment packed with **redis**, **celery**, **postgres** and everything you need to run and test django-import-export-celery.
+
+Before submitting a PR please run `flake8` and (in the examples directory) `python3 manange.py test`.
+
+Please note, that you need to restart celery for changes to propogate to the workers. Do this with `docker-compose down celery`, `docker-compose up celery`.
+
 Credits
 -------
 

dev-entrypoint.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+cd example
+poetry shell

develop.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+docker-compose down
+docker-compose up -d
+exec docker exec -u test -it django-import-export-celery_web_1 bash --init-file "/proj/dev-entrypoint.sh"

docker-compose.yaml

@@ -14,10 +14,10 @@ services:
   user: test
   volumes:
    - ./:/proj/
-   - ./pipenv:/home/test
+   - ./pyenv:/home/test
  celery:
   build: .
-  entrypoint: poetry run celery worker -A project.celery
+  entrypoint: poetry run celery -A project.celery worker
   links:
    - postgres
    - redis
@@ -27,7 +27,7 @@ services:
   user: test
   volumes:
    - ./:/proj/
-   - ./pipenv:/home/test
+   - ./pyenv:/home/test
  redis:
   image: redis
  postgres:

setup-dev-env.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+cd example
+poetry install
+poetry run python3 manage.py migrate