Merge pull request #40 from apiad/develop

v0.6.4

Author: apiad

README.md

@@ -244,10 +244,15 @@ Staying away from `eval` and `exec` should keep you safe in most scenarios, but
 
 ## History
 
+### v0.6.4
+
+* New development environment completely based on Docker.
+* Added compatibility with Python 3.7 and 3.8.
+
 ### v0.6.3
 
-* Add `Show.append` to append existing `show` instances or direct paths.
-* Fix error with absolute path for the Markdown demo.
+* Added `Show.append` to append existing `show` instances or direct paths.
+* Fixed error with absolute path for the Markdown demo.
 * Append Markdown demo to the Python demo.
 
 ### v0.6.2
@@ -342,6 +347,24 @@ Staying away from `eval` and `exec` should keep you safe in most scenarios, but
 
 ## Collaboration
 
+This project uses a novel methodology for development, in which you only need [Docker installed](https://docs.docker.com/install/).
+Fork the project, clone, and you'll find a `dockerfile` and `docker-compose.yml` files in the project root.
+We provided [packaged testing environments](https://github.com/apiad/auditorium/packages) (in the form of Docker images) for all the Python versions we target.
+There is also a `makefile` with all the necessary commands.
+
+The workflow is something like this:
+* Fork, clone, and make some changes.
+* Run `make` to run the local, fast tests. The first time this will download the corresponding image.
+* Fix errors (if any) and watch the testing coverage. Make sure to at least cover the newly added features.
+* Run `make test-full` to run the local but long tests. This will download all the remaining images for each Python environment.
+* If all worked, push and pull-request.
+
+If you need to tinker with the dev environment, `make shell` will open a shell inside the latest Python environment where you can run and test commands.
+
+This project uses [poetry](https://python-poetry.org/) for package management. If you need to install new dependencies, run `make shell` and then `poetry add ...` inside the dockerized environment. Finally, don't forget to `poetry lock` and commit the changes to `pyproject.toml` and `poetry.lock` files.
+
+## License
+
 License is MIT, so you know the drill: fork, develop, add tests, pull request, rinse and repeat.
 
 > MIT License

makefile

@@ -9,8 +9,11 @@ test-fast:
 shell:
 	PYTHON_VERSION=${BASE_VERSION} docker-compose run auditorium-tester bash
 
+lock:
+	PYTHON_VERSION=${BASE_VERSION} docker-compose run auditorium-tester poetry lock
+
 build:
-	PYTHON_VERSION=${BASE_VERSION} docker-compose run auditorium-tester make dev-build
+	PYTHON_VERSION=${BASE_VERSION} docker-compose run auditorium-tester poetry build
 
 clean:
 	git clean -fxd
@@ -36,9 +39,6 @@ dev-ensure:
 	# Check if you are inside a development environment
 	echo ${BUILD_ENVIRONMENT} | grep "development" >> /dev/null
 
-dev-build: dev-ensure
-	poetry build
-
 dev-install: dev-ensure
 	pip install poetry
 	poetry config virtualenvs.create false

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "auditorium"
-version = "0.6.3"
+version = "0.6.4"
 description = "A Python-powered slideshow maker with steroids."
 authors = ["Alejandro Piad <[email protected]>"]
 license = "MIT"