Release/1.4.0 (#299)

* Update changelog.

* Update Zenodo metadata.

* Move deployment scripts.

* Apply flake8 to tests.

* Add license to MANIFEST.in.

* Create source distribution and test before deploying.

* Update setup.py.

* Consolidate bumpversion config into setup.cfg.

* Bump up to version 1.4.0.

.circleci/config.yml

@@ -19,8 +19,8 @@ jobs:
       - run:
           name: style-check
           command: |
-            pip install --progress-bar off --user -U flake8==3.7.1
-            python -m flake8 --show-source signac/
+            pip install --progress-bar off --user -U flake8==3.7.9
+            python -m flake8 --show-source .
 
 
   linux-python-38: &linux-template
@@ -155,8 +155,7 @@ jobs:
       - run:
           name: test-deploy-pypi
           command: |
-            pip install --progress-bar off --user -U -r .requirements-deploy.txt
-            bash .test-deploy.bash
+            bash .circleci/deploy.bash testpypi
 
   deploy-pypi:
     docker:
@@ -167,8 +166,7 @@ jobs:
       - run:
           name: deploy-pypi
           command: |
-            pip install --progress-bar off --user -U -r .requirements-deploy.txt
-            bash .deploy.bash
+            bash .circleci/deploy.bash pypi
 
 
 workflows:

.circleci/deploy.bash

@@ -0,0 +1,42 @@
+#!/bin/bash
+
+set -e
+set -u
+
+python -m pip install --progress-bar off --user -U -r requirements-dev.txt
+python -m pip install --progress-bar off --user -U twine wheel setuptools
+
+# PYPI_USERNAME - (Required) Username for the publisher's account on PyPI
+# PYPI_PASSWORD - (Required, Secret) Password for the publisher's account on PyPI
+
+cat << EOF > ~/.pypirc
+[distutils]
+index-servers=
+    pypi
+    testpypi
+
+[pypi]
+username: ${PYPI_USERNAME}
+password: ${PYPI_PASSWORD}
+
+[testpypi]
+repository: https://test.pypi.org/legacy/
+username: ${PYPI_USERNAME}
+password: ${PYPI_PASSWORD}
+EOF
+
+# Create wheels and source distribution
+python setup.py bdist_wheel
+python setup.py sdist
+
+# Test generated wheel
+python -m pip install signac --progress-bar off -U --force-reinstall -f dist/
+python -m pytest tests/ -v
+
+# Upload wheels
+if [[ "$1" == "testpypi" || "$1" == "pypi" ]]; then
+    python -m twine upload --skip-existing --repository $1 dist/*
+else
+    echo "A valid repository must be provided: pypi or testpypi."
+    exit 1
+fi

.zenodo.json

@@ -55,6 +55,14 @@
             "affiliation": "University of Michigan",
             "name": "Brandon Butler",
             "orcid": "0000-0001-7739-7796"
+        },
+        {
+            "affiliation": "National Institute of Technology, Hamirpur",
+            "name": "Vishav Sharma"
+        },
+        {
+            "affiliation": "Indian Institute of Technology, Gandhinagar",
+            "name": "Abhavya Chandra"
         }
     ],
     "creators": [
@@ -102,5 +110,5 @@
         "id": "http://www.opensource.org/licenses/BSD-3-Clause"
     },
     "title": "signac",
-    "version": "1.3.0"
+    "version": "1.4.0"
 }

CITATION.cff

@@ -2,7 +2,7 @@
 ---
 cff-version: "1.0.3"
 title: signac
-version: 1.3.0
+version: 1.4.0
 abstract: |
     The signac framework helps users manage and scale file-based workflows, facilitating data
     reuse, sharing, and reproducibility. It provides a simple and robust data model to create

MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE.txt

changelog.txt

@@ -7,8 +7,8 @@ The **signac** package follows `semantic versioning <https://semver.org/>`_.
 Version 1
 =========
 
-next
-----
+[1.4.0] -- 2020-02-28
+---------------------
 
 Added
 +++++
@@ -27,16 +27,16 @@ Fixed
 +++++
 
  - Fixed issues on Windows with ``H5Store``, project import/export, and operations that move files (#264, #266).
- - Calling ``items`` or ``values`` on _SyncedDict objects does not mutate nested dictionaries (#234, #269).
- - Fixed issue with ``project.data`` access from separate instances of ``H5StoreManager` (#274, #278).
- - Fixed error when launching signac shell if permission are denied for .signac_shell_history (#279).
+ - Calling ``items`` or ``values`` on ``_SyncedDict`` objects does not mutate nested dictionaries (#234, #269).
+ - Fixed issue with ``project.data`` access from separate instances of ``H5StoreManager`` (#274, #278).
+ - Fixed error when launching ``signac shell`` if permissions are denied for ``.signac_shell_history`` (#279).
 
 Removed
 +++++++
 
  - Removed vendored ``tqdm`` module and replaced it with a requirement (#289).
  - Removed support for ``rapidjson`` as an alternative JSON library (#285, #287).
- - Removed tuple of keys implementation of Nested Dict (#272, #296).
+ - Removed tuple of keys implementation of nested dictionaries (#272, #296).
 
 
 [1.3.0] -- 2019-12-20

doc/conf.py

@@ -79,9 +79,9 @@ def __getattr__(cls, name):
 # built documents.
 #
 # The short X.Y version.
-version = '1.3.0'
+version = '1.4.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.3.0'
+release = '1.4.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.cfg

@@ -1,13 +1,30 @@
+[bumpversion]
+current_version = 1.4.0
+commit = True
+tag = False
+message = Bump up to version {new_version}.
+
 [metadata]
 description-file = README.md
 
 [bdist_wheel]
 python-tag = py3
 
 [flake8]
-max-line-length=100
+max-line-length = 100
 exclude = configobj,passlib,cite.py,conf.py
 
 [tool:pytest]
-filterwarnings =
-    ignore: .*[The indexing module | get_statepoint] is deprecated.*: DeprecationWarning
+filterwarnings = 
+	ignore: .*[The indexing module | get_statepoint] is deprecated.*: DeprecationWarning
+
+[bumpversion:file:setup.py]
+
+[bumpversion:file:signac/version.py]
+
+[bumpversion:file:doc/conf.py]
+
+[bumpversion:file:CITATION.cff]
+
+[bumpversion:file:.zenodo.json]
+

setup.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2020 The Regents of the University of Michigan
+# All rights reserved.
+# This software is licensed under the BSD 3-Clause License.
 import os
 from setuptools import setup, find_packages
 
@@ -13,7 +16,7 @@
     'tqdm>=4.10.0',
 ]
 
-description = "Simple file data management database."
+description = "Manage large and heterogeneous data spaces on the file system."
 
 try:
     this_path = os.path.dirname(os.path.abspath(__file__))
@@ -25,17 +28,19 @@
 
 setup(
     name='signac',
-    version='1.3.0',
+    version='1.4.0',
     packages=find_packages(),
     zip_safe=True,
-
-    author='Carl Simon Adorf',
+    maintainer='signac Developers',
+    maintainer_email='[email protected]',
+    author='Carl Simon Adorf et al.',
     author_email='[email protected]',
     description=description,
     long_description=long_description,
     long_description_content_type="text/markdown",
-    keywords='simulation database index collaboration workflow',
     url="https://signac.io",
+    download_url="https://pypi.org/project/signac/",
+    keywords='simulation database index collaboration workflow',
 
     classifiers=[
         "Development Status :: 5 - Production/Stable",

signac/version.py

@@ -3,7 +3,7 @@
 # This software is licensed under the BSD 3-Clause License.
 
 
-__version__ = "1.3.0"
+__version__ = "1.4.0"
 
 SCHEMA_VERSION = "1"
 

tests/test_h5store.py

@@ -23,7 +23,6 @@
 from signac.errors import InvalidKeyError
 
 
-
 PYPY = 'PyPy' in platform.python_implementation()
 
 try:

tests/test_indexing.py

@@ -27,7 +27,6 @@
 from unittest.mock import Mock
 
 
-
 SIGNAC_ACCESS_MODULE_LEGACY = r"""import os
 import re
 

tests/test_job.py

@@ -23,7 +23,6 @@
 from signac.errors import KeyTypeError
 
 
-
 try:
     import h5py    # noqa
     H5PY = True

tests/test_jsondict.py

@@ -25,7 +25,6 @@ def setUp(self, request):
         self._tmp_dir = TemporaryDirectory(prefix='jsondict_')
         request.addfinalizer(self._tmp_dir.cleanup)
         self._fn_dict = os.path.join(self._tmp_dir.name, FN_DICT)
-
 
 
 class TestJSONDict(TestJSONDictBase):