build: docker setup

[pedrohbtp]

My changes in this PR:

• I added a Dockerfile and a docker-compose to make it more convenient for people that want to contribute and use docker to set things up
• Updated CONTRIBUTING.md showing how to run using docker
• Changed the typo precommit to pre-commit that slipped through the review you previously asked

[dedoussis]

Thanks for putting together a PR! Really appreciated 💯

Kudos for spotting the pre-commit typo's.

I generally like the docker instructions idea, but I think having the Dockerfile and docker-compose.yml files at the root of the repo takes it a bit too far.

[dedoussis]

Suggested change

	``` bash
	```bash
	```

[dedoussis]

Just some indentation. Not important, but my local markdown linter complains 🙈

[dedoussis]

🚀

[dedoussis]

Although I really like having docker as my local dev environment, this is not the case for everyone. I agree that it would be beneficial to have a docker setup section in the contributing guidelines, however I don't think we should have a Dockerfile and docker-compose featuring at the root of the repo. If we were going down this path, then we could also include vscode or PyCharm configurations (since a lot of people use their IDE to spin up the environment) and we would end up overloading the repository with multiple configuration setups.

[dedoussis]

Have also taken a look at other repos of popular python web frameworks such as Flask, django and aiohttp.

None of these include docker setups, so I would prefer to adopt the same philosophy for Asynction.

[dedoussis]

However, I do like your idea of having some quick docker setup instructions in the contributing guidelines. We could do this with a docker run one liner. For example:

docker run -it --rm \
  -v ${PWD}:/opt/workspaces/asynction \
  -w /opt/workspaces/asynction \
  python:3.7 bash -c "python -m pip install --upgrade pip setuptools && make all-install && pre-commit install && exec bash"

I also think that the non-docker setup instructions should be placed above the docker instructions, since most people are likely going to use the non-docker ones.

[pedrohbtp]

Thanks for the reply! I see the point.
Since we are not adding the docker files, how do you want to move forward with this PR?
We could close this one and create a cleaner one with only that docker command and the precommit typo fixed.
Next time I might create an issue first to avoid these problems

[dedoussis]

We could close this one and create a cleaner one with only that docker command and the precommit typo fixed.

Up to you -- whatever works for you best. 👍

[dedoussis]

I prefer it the way it was. More concise. No one is going to look for the table of contents while reading the table of contents.