Merge pull request #24 from whitemech/develop

Release 0.1.0

.coveragerc

@@ -1,6 +1,6 @@
 [run]
 branch = True
-source = fondpddl
+source = pddl
 
 [report]
 exclude_lines =

.github/RELEASE_PR.md

@@ -15,7 +15,7 @@ _Put an `x` in the boxes that apply._
 - [ ] I've updated the dependencies versions in `Pipfile` to the latest, wherever is possible.
 - [ ] Lint and unit tests pass locally (please run tests also manually, not only with `tox`)
 - [ ] I built the documentation and updated it with the latest changes
-- [ ] I've added an item in `HISTORY.md` for this release
+- [ ] I've added an item in `CHANGES.md` for this release
 - [ ] I bumped the version number in the `__version__.py` file.
 - [ ] I published the latest version on TestPyPI and checked that the following command work:
        ```pip install hoa2dot==<version-number> --index-url https://test.pypi.org/simple --force --no-cache-dir --no-deps```

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - develop
+      - master
+  pull_request:
+
+jobs:
+  run:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.7]
+
+    timeout-minutes: 30
+
+    steps:
+    - uses: actions/checkout@master
+    - uses: actions/setup-python@master
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run:  pip install tox
+    - name: Generate Documentation
+      run: tox -e docs

.github/workflows/linting.yml

@@ -0,0 +1,40 @@
+name: lint
+
+on:
+  push:
+    branches:
+      - develop
+      - master
+  pull_request:
+
+jobs:
+  run:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.7]
+
+    timeout-minutes: 30
+
+    steps:
+    - uses: actions/checkout@master
+    - uses: actions/setup-python@master
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run:  pip install tox
+    - name: Code style check
+      run: |
+        tox -e black-check
+        tox -e isort-check
+        tox -e flake8
+    - name: Unused code check
+      run: tox -e vulture
+#    - name: Docstring check
+#      run: tox -e darglint
+    - name: Static type check
+      run: tox -e mypy
+    - name: Check copyright
+      run: tox -e check-copyright

.github/workflows/pythonpackage.yml → .github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: fondpddl CI pipeline.
+name: test
 
 on:
   push:
@@ -25,12 +25,6 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run:  pip install tox
-    - name: Code style check
-      run: |
-        tox -e black
-        tox -e flake8
-    - name: Static type check
-      run: tox -e mypy
     - name: Unit tests and coverage
       run: |
         tox -e py${{ matrix.python-version }}

AUTHORS.md

@@ -1,7 +1,8 @@
 # Credits
 
-## Maintainer
+## Maintainers
 
+* [Marco Favorito](https://github.com/marcofavorito) <[[email protected]](mailto:[email protected])>
 * [Francesco Fuggitti](https://github.com/francescofuggitti) <[[email protected]](mailto:[email protected])>
 
 ## Contributors

CHANGES.md

@@ -0,0 +1,6 @@
+# Change Log
+
+## 0.0.1 (2020-07-30)
+
+* First commit on the package.
+

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 Contributions are welcome, and greatly appreciated! Every little bit helps, and credit will always be given.
 
 If you need support, want to report/fix a bug, ask for/implement features, you can check the
-[Issues page](https://github.com/whitemech/fondpddl/issues)
-or [submit a Pull request](https://github.com/whitemech/fondpddl/pulls).
+[Issues page](https://github.com/whitemech/pddl/issues)
+or [submit a Pull request](https://github.com/whitemech/pddl/pulls).
 
 For other kinds of feedback, you can contact one of the [authors](./authors.md) by email.

MANIFEST.in

@@ -1,6 +1,6 @@
 include AUTHORS.md
 include CONTRIBUTING.md
-include HISTORY.md
+include CHANGES.md
 include LICENSE
 include README.md
 include Pipfile

Makefile

@@ -29,7 +29,7 @@ BROWSER := python -c "$$BROWSER_PYSCRIPT"
 help:
 	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
 
-clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+clean: clean-build clean-pyc clean-test clean-docs ## remove all build, test, coverage and Python artifacts
 
 clean-build: ## remove build artifacts
 	rm -fr build/
@@ -44,38 +44,71 @@ clean-pyc: ## remove Python file artifacts
 	find . -name '*~' -exec rm -f {} +
 	find . -name '__pycache__' -exec rm -fr {} +
 
+clean-docs:  ## remove MkDocs products.
+	mkdocs build --clean
+	rm -fr site/
+
+
 clean-test: ## remove test and coverage artifacts
 	rm -fr .tox/
 	rm -f .coverage
 	rm -fr htmlcov/
 	rm -fr .pytest_cache
 	rm -fr .mypy_cache
+	rm -fr coverage.xml
+
+lint-all: black isort lint static vulture darglint ## run all linters
 
 lint: ## check style with flake8
-	flake8 fondpddl tests
+	flake8 pddl tests
+
+static: ## static type checking with mypy
+	mypy pddl tests
+
+isort: ## sort import statements with isort
+	isort pddl tests
+
+isort-check: ## check import statements order with isort
+	isort --check-only pddl tests
+
+black: ## apply black formatting
+	black pddl tests
+
+black-check: ## check black formatting
+	black --check --verbose pddl tests
+
+vulture: ## check unused code
+	vulture pddl scripts/whitelist.py
+
+darglint: ## check docstrings
+	darglint pddl scripts/whitelist.py
+	darglint aea
 
 test: ## run tests quickly with the default Python
-	py.test
+	pytest tests --doctest-modules \
+        pddl tests/ \
+        --cov=pddl \
+        --cov-report=xml \
+        --cov-report=html \
+        --cov-report=term
 
 test-all: ## run tests on every Python version with tox
 	tox
 
 coverage: ## check code coverage quickly with the default Python
-	coverage run --source fondpddl -m pytest
+	coverage run --source pddl -m pytest
 	coverage report -m
 	coverage html
 	$(BROWSER) htmlcov/index.html
 
-docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/fondpddl.rst
-	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ fondpddl
-	$(MAKE) -C docs clean
-	$(MAKE) -C docs html
-	$(BROWSER) docs/_build/html/index.html
+docs: ## generate MkDocs HTML documentation, including API docs
+	mkdocs build --clean
+	$(BROWSER) site/index.html
 
 servedocs: docs ## compile the docs watching for changes
-	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
+	mkdocs build --clean
+	python -c 'print("###### Starting local server. Press Control+C to stop server ######")'
+	mkdocs serve
 
 release: dist ## package and upload a release
 	twine upload dist/*
@@ -87,3 +120,6 @@ dist: clean ## builds source and wheel package
 
 install: clean ## install the package to the active Python's site-packages
 	python setup.py install
+
+develop: clean ## install the package in development mode
+	pip install -e .

Pipfile

@@ -5,21 +5,23 @@ verify_ssl = true
 
 [dev-packages]
 pytest = "*"
+pytest-cov = "*"
+pytest-lazy-fixture = "*"
 tox = "*"
 ipython = "*"
 codecov = "*"
 tox-travis = "*"
-black = "==19.3b0"
+black = "==19.10b0"
 mypy = "*"
 flake8 = "*"
 flake8-docstrings = "*"
-pytest-cov = "*"
 mkdocs = "*"
 markdown-include = "*"
-v = {editable = true,version = "*"}
-
-[packages]
-lark-parser = "==0.7.8"
+isort = "*"
+mistune = "==2.0.0a4"
+mkdocs-material = "*"
+types-click = "*"
+vulture = "*"
 
 [requires]
-python_version = ">=3.6"
+python_version = "3.7"