Upgrade Makefile and install instructions and remove old unneeded stuff

Author: csala

CONTRIBUTING.rst

@@ -69,8 +69,7 @@ Ready to contribute? Here's how to set up `Copulas` for local development.
 
     $ mkvirtualenv Copulas
     $ cd Copulas/
-    $ pip install -e .
-    $ pip install -r requirements_dev.txt
+    $ make install-develop
 
 4. Create a branch for local development::
 
@@ -181,14 +180,16 @@ The process of releasing a new version involves several steps combining both ``g
 these changes are committed and available in ``master`` branch.
 Normally this is just a list of the Pull Requests that have been merged since the latest version.
 
-Once this is done, just run the following commands::
+Once this is done, run of the following commands:
+
+1. If you are releasing a patch version::
 
-    git checkout stable
-    git merge --no-ff master    # This creates a merge commit
-    bumpversion release   # This creates a new commit and a TAG
-    git push --tags origin stable
     make release
-    git checkout master
-    git merge stable
-    bumpversion --no-tag patch
-    git push
+
+2. If you are releasing a minor version::
+
+    make release-minor
+
+3. If you are releasing a major version::
+
+    make release-major

Makefile

@@ -1,4 +1,3 @@
-.PHONY: clean clean-test clean-pyc clean-build clean-docs docs help
 .DEFAULT_GOAL := help
 
 define BROWSER_PYSCRIPT
@@ -26,38 +25,71 @@ export PRINT_HELP_PYSCRIPT
 
 BROWSER := python -c "$$BROWSER_PYSCRIPT"
 
+.PHONY: help
 help:
 	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
 
-clean: clean-build clean-pyc clean-test clean-docs ## remove all build, test, coverage, docs and Python artifacts
 
+# CLEAN TARGETS
+
+.PHONY: clean-build
 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 {} +
 
+.PHONY: clean-pyc
 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 {} +
 
+.PHONY: clean-docs
+clean-docs: ## remove previously built docs
+	-$(MAKE) -C docs clean 2>/dev/null  # this fails if sphinx is not yet installed
+
+.PHONY: clean-coverage
 clean-coverage: ## remove coverage artifacts
 	rm -f .coverage
 	rm -f .coverage.*
 	rm -fr htmlcov/
 
-clean-test: ## remove test and coverage artifacts
+.PHONY: clean-test
+clean-test: ## remove test artifacts
 	rm -fr .tox/
 	rm -fr .pytest_cache
 
+.PHONY: clean
+clean: clean-build clean-pyc clean-test clean-coverage clean-docs ## remove all build, test, coverage, docs and Python artifacts
+
+
+# INSTALL TARGETS
+
+.PHONY: install
+install: clean-build clean-pyc ## install the package to the active Python's site-packages
+	pip install .
+
+.PHONY: install-test
+install-test: clean-build clean-pyc ## install the package and test dependencies
+	pip install .[test]
+
+.PHONY: install-develop
+install-develop: clean-build clean-pyc ## install the package in editable mode and dependencies for development
+	pip install -e .[dev]
+
+
+# LINT TARGETS
+
+.PHONY: lint
 lint: ## check style with flake8 and isort
 	flake8 copulas tests examples
 	isort -c --recursive copulas tests examples
 
-fixlint: ## fix lint issues using autoflake, autopep8, and isort
+.PHONY: fix-lint
+fix-lint: ## fix lint issues using autoflake, autopep8, and isort
 	find copulas -name '*.py' | xargs autoflake --in-place --remove-all-unused-imports --remove-unused-variables
 	autopep8 --in-place --recursive --aggressive copulas
 	isort --apply --atomic --recursive copulas
@@ -70,45 +102,97 @@ fixlint: ## fix lint issues using autoflake, autopep8, and isort
 	autopep8 --in-place --recursive --aggressive examples
 	isort --apply --atomic --recursive examples
 
+# TEST TARGETS
+
+.PHONY: test
 test: ## run tests quickly with the default Python
-	pytest
+	python -m pytest --cov=copulas
 
+.PHONY: test-all
 test-all: ## run tests on every Python version with tox
 	tox
 
-coverage: clean-coverage ## check code coverage quickly with the default Python
+.PHONY: coverage
+coverage: ## check code coverage quickly with the default Python
 	coverage run --source copulas -m pytest
 	coverage report -m
 	coverage html
 	$(BROWSER) htmlcov/index.html
 
-clean-docs: ## remove previously built docs
-	rm -f docs/copulas.rst
-	rm -f docs/copulas.*.rst
-	rm -f docs/modules.rst
-	$(MAKE) -C docs clean
 
+# DOCS TARGETS
+
+.PHONY: docs
 docs: clean-docs ## generate Sphinx HTML documentation, including API docs
-	sphinx-apidoc -o docs/ copulas
 	$(MAKE) -C docs html
 	touch docs/_build/html/.nojekyll
 
-viewdocs: docs ## view docs in browser
+.PHONY: view-docs
+view-docs: docs ## view docs in browser
 	$(BROWSER) docs/_build/html/index.html
 
-servedocs: docs ## compile the docs watching for changes
-	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
+.PHONY: serve-docs
+serve-docs: view-docs ## compile the docs watching for changes
+	watchmedo shell-command -W -R -D -p '*.rst;*.md' -c '$(MAKE) -C docs html' docs
 
-release: dist ## package and upload a release
-	twine upload dist/*
 
-test-release: dist ## package and upload a release on TestPyPI
-	twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+# RELEASE TARGETS
 
+.PHONY: dist
 dist: clean ## builds source and wheel package
 	python setup.py sdist
 	python setup.py bdist_wheel
 	ls -l dist
 
-install: clean ## install the package to the active Python's site-packages
-	python setup.py install
+.PHONY: test-publish
+test-publish: dist ## package and upload a release on TestPyPI
+	twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+
+.PHONY: publish
+publish: dist ## package and upload a release
+	twine upload dist/*
+
+.PHONY: bumpversion-release
+bumpversion-release: ## Merge master to stable and bumpversion release
+	git checkout stable
+	git merge --no-ff master -m"make release-tag: Merge branch 'master' into stable"
+	bumpversion release
+	git push --tags origin stable
+
+.PHONY: bumpversion-patch
+bumpversion-patch: ## Merge stable to master and bumpversion patch
+	git checkout master
+	git merge stable
+	bumpversion --no-tag patch
+	git push
+
+.PHONY: bumpversion-minor
+bumpversion-minor: ## Bump the version the next minor skipping the release
+	bumpversion --no-tag minor
+
+.PHONY: bumpversion-major
+bumpversion-major: ## Bump the version the next major skipping the release
+	bumpversion --no-tag major
+
+CURRENT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
+CHANGELOG_LINES := $(shell git diff HEAD..stable HISTORY.md | wc -l)
+
+.PHONY: check-release
+check-release: ## Check if the release can be made
+ifneq ($(CURRENT_BRANCH),master)
+	$(error Please make the release from master branch\n)
+endif
+ifeq ($(CHANGELOG_LINES),0)
+	$(error Please insert the release notes in HISTORY.md before releasing)
+else
+	@echo "A new release can be made"
+endif
+
+.PHONY: release
+release: check-release bumpversion-release publish bumpversion-patch
+
+.PHONY: release-minor
+release-minor: check-release bumpversion-minor release
+
+.PHONY: release-major
+release-major: check-release bumpversion-major release

docs/installation.rst

@@ -32,20 +32,20 @@ You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git://github.com/DAI-Lab/copulas
+    $ git clone git://github.com/DAI-Lab/Copulas
 
 Or download the `tarball`_:
 
 .. code-block:: console
 
-    $ curl  -OL https://github.com/DAI-Lab/copulas/tarball/master
+    $ curl  -OL https://github.com/DAI-Lab/Copulas/tarball/master
 
 Once you have a copy of the source, you can install it with:
 
 .. code-block:: console
 
-    $ python setup.py install
+    $ make install
 
 
-.. _Github repo: https://github.com/DAI-Lab/copulas
-.. _tarball: https://github.com/DAI-Lab/copulas/tarball/master
+.. _Github repo: https://github.com/DAI-Lab/Copulas
+.. _tarball: https://github.com/DAI-Lab/Copulas/tarball/master

requirements_dev.txt

@@ -37,6 +37,7 @@
 
 tests_require = [
     'pytest>=3.4.2',
+    'pytest-cov>=2.6.0',
 ]
 
 setup_requires = [

setup.py

@@ -72,8 +72,9 @@ def test_to_dict(self):
         # Check
         assert result == expected_result
 
+    @mock.patch("builtins.open")
     @mock.patch('copulas.bivariate.base.json.dump')
-    def test_save(self, json_mock):
+    def test_save(self, json_mock, open_mock):
         """Save stores the internal dictionary as a json in a file."""
         # Setup
         instance = Bivariate('frank')
@@ -89,12 +90,13 @@ def test_save(self, json_mock):
         instance.save('test.json')
 
         # Check
+        assert open_mock.called_once_with('test.json', 'w')
         assert json_mock.called
         compare_nested_dicts(json_mock.call_args[0][0], expected_content)
 
-    @mock.patch('builtins.open', new_callable=mock.mock_open)
+    @mock.patch('builtins.open')
     @mock.patch('copulas.bivariate.base.json.load')
-    def test_load_from_file(self, json_mock, file_mock):
+    def test_load_from_file(self, json_mock, open_mock):
         """Load can recreate an instance from a saved file."""
         # Setup
         json_mock.return_value = {
@@ -107,6 +109,7 @@ def test_load_from_file(self, json_mock, file_mock):
         instance = Bivariate.load('somefile.json')
 
         # Check
+        assert open_mock.called_once_with('test.json', 'r')
         instance.copula_type == CopulaTypes.FRANK
         instance.tau == -0.33333333333333337
         instance.theta == -3.305771759329249

tests/copulas/bivariate/test_base.py

@@ -372,8 +372,9 @@ def test_from_dict(self):
         # This isn't to check the sampling, but that the copula is able to run.
         assert copula.sample(10).all().all()
 
+    @mock.patch("builtins.open")
     @mock.patch('copulas.multivariate.base.json.dump')
-    def test_save(self, json_mock):
+    def test_save(self, json_mock, open_mock):
         """Save stores the internal dictionary as a json in a file."""
         # Setup
         instance = GaussianMultivariate()
@@ -423,11 +424,12 @@ def test_save(self, json_mock):
         instance.save('test.json')
 
         # Check
+        assert open_mock.called_once_with('test.json', 'w')
         compare_nested_dicts(json_mock.call_args[0][0], expected_content)
 
-    @mock.patch('builtins.open', new_callable=mock.mock_open)
+    @mock.patch('builtins.open')
     @mock.patch('copulas.bivariate.base.json.load')
-    def test_load(self, json_mock, file_mock):
+    def test_load(self, json_mock, open_mock):
         """Load can recreate an instance from a saved file."""
         # Setup
         covariance = [
@@ -470,7 +472,7 @@ def test_load(self, json_mock, file_mock):
         }
 
         # Run
-        instance = GaussianMultivariate.load('somefile.json')
+        instance = GaussianMultivariate.load('test.json')
 
         # Check
         assert (instance.covariance == np.array([
@@ -482,3 +484,5 @@ def test_load(self, json_mock, file_mock):
 
         for name, distrib in instance.distribs.items():
             assert instance.distribs[name].to_dict() == json_mock.return_value['distribs'][name]
+
+        assert open_mock.called_once_with('test.json', 'r')

tests/copulas/multivariate/test_gaussian_copula.py

@@ -9,23 +9,23 @@ python =
 
 
 [testenv]
+passenv = CI TRAVIS TRAVIS_*
 setenv =
     PYTHONPATH = {toxinidir}
+extras = test
 commands =
-    /usr/bin/env python setup.py test
+    /usr/bin/env python -m pytest --cov=copulas
 
 
 [testenv:lint]
 skipsdist = true
-deps =
-    -r{toxinidir}/requirements_dev.txt
+extras = dev
 commands =
     /usr/bin/env make lint
 
 
 [testenv:docs]
 skipsdist = true
-deps =
-    -r{toxinidir}/requirements_dev.txt
+extras = dev
 commands =
     /usr/bin/env make docs