Packaging

.travis.yml

@@ -6,27 +6,26 @@ python:
   - 3.7
 
 before_install:
-  # Install node.js following instructions from
-  #   https://nodejs.org/en/download/package-manager/
-  - sudo apt install curl
-  - curl -sL https://deb.nodesource.com/setup_11.x | sudo bash -
-  - sudo apt install nodejs
+  # Use the pre-installed nvm version to update node
+  # Apparently Travis comes with nvm even on the python containers
+  - nvm install v12.18.1
+  - nvm use v12.18.1
+  - node -v
+  - npm version
 
 install:
-  # Install node.js dependencies
-  - npm install
-  # Install python dependencies
-  - pip install -r requirements-dev.txt
+  # Install package, while updating dependencies
+  - pip install --upgrade --upgrade-strategy eager .[dev]
 
 script:
   # Run all pytest unit tests
-  - python -m pytest -v tests --cov readabilipy --cov-report term-missing --benchmark-disable
+  - cd tests && python -m pytest -v . --cov readabilipy --cov-report term-missing --benchmark-disable && cd ..
   # Run pyflakes for error detection
   - pyflakes *.py readabilipy tests
   # Check PEP8 compliance (ignoring long lines)
   - pycodestyle --statistics --ignore=E501 --count *.py readabilipy tests
   # Run pylint for stricter error checking
-  - pylint readabilipy tests
+  - pylint readabilipy
 
 after_success:
   # Upload results to coveralls.io

MANIFEST.in

@@ -0,0 +1,2 @@
+include readabilipy/javascript/*.js
+include readabilipy/javascript/package.json

Makefile

@@ -0,0 +1,108 @@
+# Makefile for easier installation and cleanup.
+#
+# Uses self-documenting macros from here:
+# http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+
+SHELL := bash
+.SHELLFLAGS := -eu -o pipefail -c
+MAKEFLAGS += --warn-undefined-variables --no-builtin-rules
+
+PACKAGE=readabilipy
+DOC_DIR=./docs
+VENV_DIR=/tmp/rdpy_venv
+TEST_DIR=./tests
+
+.PHONY: help
+
+.DEFAULT_GOAL := help
+
+help:
+	@grep -E '^[0-9a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) |\
+		 awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-15s\033[0m\
+		 %s\n", $$1, $$2}'
+
+################
+# Installation #
+################
+
+.PHONY: install
+
+install: ## Install for the current user using the default python command
+	python setup.py build_ext --inplace
+	python setup.py install --user
+
+
+################
+# Distribution #
+################
+
+.PHONY: release dist
+
+release: ## Make a release
+	python make_release.py
+
+dist: ## Make Python source distribution
+	python setup.py sdist bdist_wheel
+
+
+###########
+# Testing #
+###########
+
+.PHONY: test
+
+test: venv ## Run unit tests
+	source $(VENV_DIR)/bin/activate && cd $(TEST_DIR) && \
+		python -m pytest -v . --cov readabilipy \
+		--cov-report term-missing --benchmark-disable
+	source $(VENV_DIR)/bin/activate && pyflakes *.py readabilipy tests
+	source $(VENV_DIR)/bin/activate && pycodestyle --statistics \
+		--ignore=E501 --count *.py readabilipy tests
+	source $(VENV_DIR)/bin/activate && pylint readabilipy
+
+#################
+# Documentation #
+#################
+
+.PHONY: doc docs
+
+docs: doc
+doc: install ## Build documentation with Sphinx
+	exit; # not implemented
+	source $(VENV_DIR)/bin/activate && m2r README.md && mv README.rst $(DOC_DIR)
+	source $(VENV_DIR)/bin/activate && m2r CHANGELOG.md && mv CHANGELOG.rst $(DOC_DIR)
+	cd $(DOC_DIR) && \
+		rm source/* && \
+		source $(VENV_DIR)/bin/activate && \
+		sphinx-apidoc -H 'Paper2Remarkable API Documentation' -o source ../$(PACKAGE) && \
+		touch source/AUTOGENERATED
+	$(MAKE) -C $(DOC_DIR) html
+
+#######################
+# Virtual environment #
+#######################
+
+.PHONY: venv
+
+venv: $(VENV_DIR)/bin/activate
+
+$(VENV_DIR)/bin/activate: setup.py
+	test -d $(VENV_DIR) || virtualenv $(VENV_DIR)
+	source $(VENV_DIR)/bin/activate && pip install .[dev]
+	touch $(VENV_DIR)/bin/activate
+
+############
+# Clean up #
+############
+
+.PHONY: clean
+
+clean: ## Clean build dist and egg directories left after install
+	rm -rf ./dist
+	rm -rf ./build
+	rm -rf ./$(PACKAGE).egg-info
+	rm -rf $(VENV_DIR)
+	rm -f MANIFEST
+	rm -rf $(PACKAGE)/javascript/node_modules
+	find . -type f -iname '*.pyc' -delete
+	find . -type d -name '__pycache__' -empty -delete