Makefile for use with docker #1879

angoru · 2018-11-29T16:32:41Z

Description

I use Makefile with docker to make it simpler call the frequent actions used in daily django development.

I've added the most frequent one. Hope it helps.

Rationale

It's not really needed but i think it saves time and remembering large commands.

Use case(s) / visualization(s)

write "make build" to set up the docker container

write "make up" to start container

write "make manage COMMAND" to call to any django command

browniebroke

Thanks for this contribution! I'd be in favour of seeing this. However, I have a few comments:

I think we should remove this file if use_docker='n'. This can be done by adding the Makefile to the post-generation hook:
https://github.com/pydanny/cookiecutter-django/blob/d299e1d354270cd0ad14514c1f069068bef882da/hooks/post_gen_project.py#L62
Ideally, could you add a clear target to clean up the docker containers & volumes, as suggested by @demestav here.
Also nice to have, you can generate a Makefile help with this neat trick.

Finally, feel free to add yourself to the list of contributors 🎉

browniebroke · 2019-03-15T14:46:54Z

Makefile

+	@docker-compose -f local.yml up
+
+build:
+	@docker-compose -f local.yml up --force-recreate --build


I find a bit confusing that make build actually does a docker-compose up .... One might want to re-build and then run a manage command rather than starting the whole stack.

What's the reason for that? I'd rather keep them a bit more separate and only do docker-compose build.

We can chain commands easily with make: make build up,

Finally, could we accept an optional parameter to rebuild only one container, e.g. django?

browniebroke · 2019-03-15T14:57:09Z

Makefile

+	@docker-compose -f local.yml up --force-recreate --build
+
+manage:
+	@docker-compose -f local.yml run --rm django python ./manage.py $(filter-out $@,$(MAKECMDGOALS)) --settings=config.settings.local


Why do we need the --settings=config.settings.local? It's the default value, so we should be able to remove it.

I use a Makefile for docker too, and IMHO its quite useful because you can easily change from local to production;

buildev: @sed -i.bak s/DJANGO_SETTINGS_MODULE=config.settings.production/DJANGO_SETTINGS_MODULE=config.settings.local/g .env @sed -i.bak s/DJANGO_DEBUG=False/DJANGO_DEBUG=True/g .env @docker-compose -f docker-compose-dev.yml up --build

and later on:

buildprod: @sed -i.bak s/DJANGO_SETTINGS_MODULE=config.settings.local/DJANGO_SETTINGS_MODULE=config.settings.production/g .env @sed -i.bak s/DJANGO_DEBUG=True/DJANGO_DEBUG=False/g .env @docker-compose -f docker-compose.yml up --build

this way its idempotent. It doesnt matter if you are already on dev environment, it will work as expected and it will change seamlessly to production in one command.

demestav · 2019-03-20T14:22:45Z

This is a great addition. Is there a particular reason why is only for local? I would also find this useful in production.

browniebroke · 2019-03-20T15:23:50Z

Maybe a better alternative would be fabric instead? Similar idea/interface as Make, but in Python, so easier to maintain IMO.

browniebroke · 2019-03-20T15:25:21Z

Would help if we want to enable more advanced things like #1133

pySilver · 2019-07-30T03:59:04Z

You can grab some commands from here if you like:

PROJECT_NAME=your_project
export COMPOSE_FILE=local.yml

.PHONY: up down stop prune ps shell logs

default: up

## help	:	Print commands help.
help : Makefile
	@sed -n 's/^##//p' $<

## up	:	Start up containers.
up:
	@echo "Starting up containers for for $(PROJECT_NAME)..."
	# @see:https://github.com/docker/compose/issues/6464
	#docker-compose pull
	docker-compose build
	docker-compose up -d --remove-orphans

## build	:	Build python image.
build:
	@echo "Building python image for for $(PROJECT_NAME)..."
	docker-compose build

## down	:	Stop containers.
down: stop

## start	:	Start containers without updating.
start:
	@echo "Starting containers for $(PROJECT_NAME) from where you left off..."
	@docker-compose start

## stop	:	Stop containers.
stop:
	@echo "Stopping containers for $(PROJECT_NAME)..."
	@docker-compose stop

## prune	:	Remove containers and their volumes.
##		You can optionally pass an argument with the service name to prune single container
##		prune mariadb	: Prune `mariadb` container and remove its volumes.
##		prune mariadb solr	: Prune `mariadb` and `solr` containers and remove their volumes.
prune:
	@echo "Removing containers for $(PROJECT_NAME)..."
	@docker-compose down -v $(filter-out $@,$(MAKECMDGOALS))

## ps	:	List running containers.
ps:
	@docker ps --filter name='$(PROJECT_NAME)*'

## manage	:	Executes `manage.py` command.
##		To use "--flag" arguments include them in quotation marks.
##		For example: make manage "makemessages --locale=pl"
.PHONY: manage
manage:
	docker-compose -f $(COMPOSE_FILE) exec django python manage.py $(filter-out $@,$(MAKECMDGOALS)) $(subst \,,$(MAKEFLAGS))


## shell	:	Access `python` container via shell.
shell:
	docker exec -ti -e COLUMNS=$(shell tput cols) -e LINES=$(shell tput lines) $(shell docker ps --filter name='$(PROJECT_NAME)_django' --format "{{ .ID }}") bash

## logs	:	View containers logs.
##		You can optionally pass an argument with the service name to limit logs
##		logs python	: View `python` container logs.
##		logs nginx python	: View `nginx` and `python` containers logs.
logs:
	@docker-compose logs -f $(filter-out $@,$(MAKECMDGOALS))

# https://stackoverflow.com/a/6273809/1826109
%:
	@:

Credits: https://github.com/wodby/docker4python

pySilver · 2020-04-27T00:17:30Z

@browniebroke I've updated my code comment (manage action had a bug)

areski · 2021-01-29T17:29:28Z

I personally like @pySilver offered option, it's a nice addition.
Maybe we should open a new PR, except if the author can follow-up

pySilver · 2021-01-29T17:32:37Z

@areski I'm using this for a long time and it is really helpful

browniebroke · 2021-02-23T12:11:20Z

This PR seems abandonded, but if someone can put together a new one based on enhancements, I'll look at it.

jugurtha114 · 2023-04-19T04:00:58Z

You can grab some commands from here if you like:

PROJECT_NAME=your_project
export COMPOSE_FILE=local.yml

.PHONY: up down stop prune ps shell logs

default: up

## help	:	Print commands help.
help : Makefile
	@sed -n 's/^##//p' $<

## up	:	Start up containers.
up:
	@echo "Starting up containers for for $(PROJECT_NAME)..."
	# @see:https://github.com/docker/compose/issues/6464
	#docker-compose pull
	docker-compose build
	docker-compose up -d --remove-orphans

## build	:	Build python image.
build:
	@echo "Building python image for for $(PROJECT_NAME)..."
	docker-compose build

## down	:	Stop containers.
down: stop

## start	:	Start containers without updating.
start:
	@echo "Starting containers for $(PROJECT_NAME) from where you left off..."
	@docker-compose start

## stop	:	Stop containers.
stop:
	@echo "Stopping containers for $(PROJECT_NAME)..."
	@docker-compose stop

## prune	:	Remove containers and their volumes.
##		You can optionally pass an argument with the service name to prune single container
##		prune mariadb	: Prune `mariadb` container and remove its volumes.
##		prune mariadb solr	: Prune `mariadb` and `solr` containers and remove their volumes.
prune:
	@echo "Removing containers for $(PROJECT_NAME)..."
	@docker-compose down -v $(filter-out $@,$(MAKECMDGOALS))

## ps	:	List running containers.
ps:
	@docker ps --filter name='$(PROJECT_NAME)*'

## manage	:	Executes `manage.py` command.
##		To use "--flag" arguments include them in quotation marks.
##		For example: make manage "makemessages --locale=pl"
.PHONY: manage
manage:
	docker-compose -f $(COMPOSE_FILE) exec django python manage.py $(filter-out $@,$(MAKECMDGOALS)) $(subst \,,$(MAKEFLAGS))


## shell	:	Access `python` container via shell.
shell:
	docker exec -ti -e COLUMNS=$(shell tput cols) -e LINES=$(shell tput lines) $(shell docker ps --filter name='$(PROJECT_NAME)_django' --format "{{ .ID }}") bash

## logs	:	View containers logs.
##		You can optionally pass an argument with the service name to limit logs
##		logs python	: View `python` container logs.
##		logs nginx python	: View `nginx` and `python` containers logs.
logs:
	@docker-compose logs -f $(filter-out $@,$(MAKECMDGOALS))

# https://stackoverflow.com/a/6273809/1826109
%:
	@:

Credits: https://github.com/wodby/docker4python

i find this useful! thanks

foarsitter · 2024-11-04T08:02:15Z

Was looking into just and found out it can be installed through pypi. Has make that capability? If that ins't the case I would favor just over make.

browniebroke · 2024-11-04T10:29:32Z

Was looking into just and found out it can be installed through pypi. Has make that capability? If that ins't the case I would favor just over make.

Yes I agree. Another benefit would be to have a more cross-platform tool, I don't think that make is widely available on Windows...

Makefile for use with docker

c5e0328

webyneter mentioned this pull request Dec 18, 2018

The DATABASE_URL environment variable couldn't found in shell #1888

Closed

browniebroke requested changes Mar 15, 2019

View reviewed changes

browniebroke added the WIP label Apr 2, 2019

browniebroke added the enhancement label Apr 15, 2020

foarsitter mentioned this pull request Sep 12, 2021

Convenient script for rapid development #3318

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Makefile for use with docker #1879

Makefile for use with docker #1879

angoru commented Nov 29, 2018

browniebroke left a comment

browniebroke Mar 15, 2019

browniebroke Mar 15, 2019

elyak123 Mar 20, 2019 •

edited

Loading

demestav commented Mar 20, 2019

browniebroke commented Mar 20, 2019

browniebroke commented Mar 20, 2019

pySilver commented Jul 30, 2019 •

edited

Loading

pySilver commented Apr 27, 2020

areski commented Jan 29, 2021

pySilver commented Jan 29, 2021

browniebroke commented Feb 23, 2021

jugurtha114 commented Apr 19, 2023

foarsitter commented Nov 4, 2024

browniebroke commented Nov 4, 2024

Makefile for use with docker #1879

Are you sure you want to change the base?

Makefile for use with docker #1879

Conversation

angoru commented Nov 29, 2018

Description

Rationale

Use case(s) / visualization(s)

browniebroke left a comment

Choose a reason for hiding this comment

browniebroke Mar 15, 2019

Choose a reason for hiding this comment

browniebroke Mar 15, 2019

Choose a reason for hiding this comment

elyak123 Mar 20, 2019 • edited Loading

Choose a reason for hiding this comment

demestav commented Mar 20, 2019

browniebroke commented Mar 20, 2019

browniebroke commented Mar 20, 2019

pySilver commented Jul 30, 2019 • edited Loading

pySilver commented Apr 27, 2020

areski commented Jan 29, 2021

pySilver commented Jan 29, 2021

browniebroke commented Feb 23, 2021

jugurtha114 commented Apr 19, 2023

foarsitter commented Nov 4, 2024

browniebroke commented Nov 4, 2024

elyak123 Mar 20, 2019 •

edited

Loading

pySilver commented Jul 30, 2019 •

edited

Loading