Merge pull request #40 from LaurentDeMontBlanc/prp4-compatibility

PRP4 compatibility

Makefile

@@ -1,4 +1,4 @@
-.PHONY: help run start stop logs test test-unit test-unit-watch test-acceptance test-integration cov doc doc-acceptance clean reset release dist check-deps clean-build clean-pyc clean-test
+.PHONY: help run start stop logs lint test test-unit test-unit-watch test-acceptance test-integration cov docs docs-acceptance clean reset release dist check-deps clean-build clean-pyc clean-test
 
 .DEFAULT_GOAL := help
 
@@ -70,6 +70,9 @@ stop: check-deps ## Stop Planetmint
 logs: check-deps ## Attach to the logs
 	@$(DC) logs -f planetmint
 
+lint: check-deps ## Lint the project
+	@$(DC) up lint
+
 test: check-deps test-unit test-acceptance ## Run unit and acceptance tests
 
 test-unit: check-deps ## Run all tests once
@@ -89,17 +92,16 @@ cov: check-deps ## Check code coverage and open the result in the browser
 	@$(DC) run --rm planetmint pytest -v --cov=planetmint --cov-report html
 	$(BROWSER) htmlcov/index.html
 
-doc: check-deps ## Generate HTML documentation and open it in the browser
+docs: check-deps ## Generate HTML documentation and open it in the browser
 	@$(DC) run --rm --no-deps bdocs make -C docs/root html
-	@$(DC) run --rm --no-deps bdocs make -C docs/server html
-	@$(DC) run --rm --no-deps bdocs make -C docs/contributing html
 	$(BROWSER) docs/root/build/html/index.html
 
-doc-acceptance: check-deps ## Create documentation for acceptance tests
+docs-acceptance: check-deps ## Create documentation for acceptance tests
 	@$(DC) run --rm python-acceptance pycco -i -s /src -d /docs
 	$(BROWSER) acceptance/python/docs/index.html
 
-clean: clean-build clean-pyc clean-test ## Remove all build, test, coverage and Python artifacts
+clean: check-deps ## Remove all build, test, coverage and Python artifacts
+	@$(DC) up clean
 	@$(ECHO) "Cleaning was successful."
 
 reset: check-deps ## Stop and REMOVE all containers. WARNING: you will LOSE all data stored in Planetmint.
@@ -126,22 +128,3 @@ ifndef IS_DOCKER_COMPOSE_INSTALLED
 	@$(ECHO)
 	@$(DC) # docker-compose is not installed, so we call it to generate an error and exit
 endif
-
-clean-build: # Remove build artifacts
-	@rm -fr build/
-	@rm -fr dist/
-	@rm -fr .eggs/
-	@find . -name '*.egg-info' -exec rm -fr {} +
-	@find . -name '*.egg' -exec rm -f {} +
-
-clean-pyc: # Remove Python file artifacts
-	@find . -name '*.pyc' -exec rm -f {} +
-	@find . -name '*.pyo' -exec rm -f {} +
-	@find . -name '*~' -exec rm -f {} +
-	@find . -name '__pycache__' -exec rm -fr {} +
-
-clean-test: # Remove test and coverage artifacts
-	@find . -name '.pytest_cache' -exec rm -fr {} +
-	@rm -fr .tox/
-	@rm -f .coverage
-	@rm -fr htmlcov/

README.md

@@ -43,10 +43,11 @@ There are also other commands you can execute:
 * `make start`: Run Planetmint from source and daemonize it (stop it with `make stop`).
 * `make stop`: Stop Planetmint.
 * `make logs`: Attach to the logs.
+* `make lint`: Lint the project
 * `make test`: Run all unit and acceptance tests.
 * `make test-unit-watch`: Run all tests and wait. Every time you change code, tests will be run again.
 * `make cov`: Check code coverage and open the result in the browser.
-* `make doc`: Generate HTML documentation and open it in the browser.
+* `make docs`: Generate HTML documentation and open it in the browser.
 * `make clean`: Remove all build, test, coverage and Python artifacts.
 * `make reset`: Stop and REMOVE all containers. WARNING: you will LOSE all data stored in Planetmint.
 

docker-compose.yml

@@ -114,3 +114,20 @@ services:
       - '33333:80'
     volumes:
       - ./docs/root/build/html:/usr/share/nginx/html
+
+  # Lints project according to PEP8
+  lint:
+    image: alpine/flake8
+    command: --max-line-length 119 /planetmint /acceptance /integration /tests
+    volumes:
+      - ./planetmint:/planetmint
+      - ./acceptance:/acceptance
+      - ./integration:/integration
+      - ./tests:/tests
+
+  # Remove all build, test, coverage and Python artifacts
+  clean:
+    image: alpine
+    command: /bin/sh -c "./planetmint/scripts/clean.sh"
+    volumes:
+      - $PWD:/planetmint

scripts/clean.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+# Copyright © 2020 Interplanetary Database Association e.V.,
+# Planetmint and IPDB software contributors.
+# SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
+# Code is Apache-2.0 and docs are CC-BY-4.0
+
+cd planetmint
+
+# Remove build artifacts
+rm -fr build/
+rm -fr dist/
+rm -fr .eggs/
+find . -name '*.egg-info' -exec rm -fr {} +
+find . -name '*.egg' -type f -exec rm -f {} +
+
+# Remove Python file artifacts
+find . -name '*.pyc' -exec rm -f {} +
+find . -name '*.pyo' -exec rm -f {} +
+find . -name '*~' -exec rm -f {} +
+find . -name '__pycache__' -exec rm -fr {} +
+
+# Remove test and coverage artifacts
+find . -name '.pytest_cache' -exec rm -fr {} +
+rm -fr .tox/
+rm -f .coverage
+rm -fr htmlcov/