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

Docker dev env #498

Open
wants to merge 4 commits into
base: master
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
11 changes: 11 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ Contribute
* Send a pull request with your changes.
* Provide a translation using Transifex_.

Running example app with Docker
----------------------------------

Run the example app on port 8000::

docker-compose up -d example_app

Running tests
-------------
This project aims for full code-coverage, this means that your code should be
Expand All @@ -32,6 +39,10 @@ covering all supported Python and Django version with::

tox

With docker run tests::

docker-compose run --rm cli bash -c "pip install -r requirements_dev.txt; make test"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this really easier than running pip install --user tox; tox? If Docker supports one-shot services maybe we should have one to run the tests?

Copy link
Author

Choose a reason for hiding this comment

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

that is always a matter of personal flavour. I like to prevent messing around locally with dozens of different virtualenvs. but I'm not the maintainer. I offered what I ran locally and others asked for it. so its up to you to find the right way for this lib.


Releasing
---------
The following actions are required to push a new version:
Expand Down
12 changes: 12 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
FROM python:3
ENV PYTHONDONTWRITEBYTECODE=1
ENV PYTHONUNBUFFERED=1
WORKDIR /code
COPY requirements_dev.txt /code/
COPY setup.py /code/
COPY README.rst /code/
RUN pip install .
RUN pip install -r requirements_dev.txt
COPY . /code/
RUN example/manage.py migrate
COPY . /code/
16 changes: 16 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version: "3.9"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this the Python version to be used? If not, where is that defined?

Copy link
Author

Choose a reason for hiding this comment

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

rtfm, sry.


x-base: &base
build: .
command: bash
volumes:
- .:/code

services:
cli:
<<: *base
example_app:
<<: *base
command: example/manage.py runserver 0.0.0.0:8000
ports:
- "8000:8000"