Merge branch 'v0.3.0'

glotzerlab · Jun 23, 2016 · a5dfd3e · a5dfd3e
2 parents a4afc99 + 9137201
commit a5dfd3e
Show file tree

Hide file tree

Showing 34 changed files with 79 additions and 57 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,22 +1,29 @@
-License for the software signac.
+BSD 3-Clause License for the software signac.
 
-Copyright (c) 2016 The Regents of the University of Michigan
+Copyright (c) 2016, The Regents of the University of Michigan
 All rights reserved.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+1.  Redistributions of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+2.  Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+3.  Neither the name of the copyright holder nor the names of its contributors may
+    be used to endorse or promote products derived from this software without
+    specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
diff --git a/changelog.txt b/changelog.txt
@@ -1,3 +1,8 @@
+0.3.0
+
+	- Change license from MIT to BSD 3-clause license.
+	- Add contributing agreement and guidelines.
+
 0.2.9
 
 	- API changes:

diff --git a/doc/conf.py b/doc/conf.py
@@ -76,9 +76,9 @@ def __getattr__(cls, name):
 # built documents.
 #
 # The short X.Y version.
-version = '0.2'
+version = '0.3'
 # The full version, including alpha/beta/rc tags.
-release = '0.2.9'
+release = '0.3.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/doc/index.rst b/doc/index.rst
@@ -33,8 +33,7 @@ Contents
 
 .. attention::
 
-    The **signac** package is hosted on `bitbucket <https://bitbucket.org/glotzer/signac>`_ and not open to the public yet.
-    Please contact `csadorf@umich.edu <mailto:csadorf@umich.edu>`_ to gain early access.
+    The **signac** package is hosted on `bitbucket <https://bitbucket.org/glotzer/signac>`_ and licensed under the open-source BSD 3-Clause license.
 
 .. toctree::
    :hidden:

diff --git a/setup.py b/setup.py
@@ -7,7 +7,7 @@
 
 setup(
     name='signac',
-    version='0.2.9',
+    version='0.3.0',
     packages=find_packages(),
     zip_safe=True,
 
@@ -19,7 +19,7 @@
     classifiers=[
         "Development Status :: 4 - Beta",
         "Intended Audience :: Science/Research",
-        "License :: OSI Approved :: MIT License",
+        "License :: OSI Approved :: BSD 3-Clause License",
         "Topic :: Scientific/Engineering :: Physics",
     ],
 

diff --git a/signac/__init__.py b/signac/__init__.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 """The signac framework aids in the management of large and
 heterogeneous data spaces.
 
@@ -17,7 +17,7 @@
 from .contrib import Project, get_project, fetch, fetch_one
 from .db import get_database
 
-__version__ = '0.2.9'
+__version__ = '0.3.0'
 
 __all__ = ['__version__', 'contrib', 'db', 'gui',
            'Project', 'get_project', 'get_database', 'fetch', 'fetch_one']
diff --git a/signac/__main__.py b/signac/__main__.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 from __future__ import print_function
 import os
 import sys

diff --git a/signac/common/__init__.py b/signac/common/__init__.py
@@ -1,3 +1,3 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
diff --git a/signac/common/config.py b/signac/common/config.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import os
 import stat
 import logging

diff --git a/signac/common/connection.py b/signac/common/connection.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import subprocess
 import logging
 import ssl

diff --git a/signac/common/crypt.py b/signac/common/crypt.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import base64
 
 from . import six

diff --git a/signac/common/errors.py b/signac/common/errors.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 
 
 class Error(Exception):
@@ -15,6 +15,7 @@ class AuthenticationError(Error, RuntimeError):
 
     def __str__(self):
         if len(self.args) > 0:
-            return "Failed to authenticate with host '{}'.".format(self.args[0])
+            return "Failed to authenticate with host '{}'.".format(
+                self.args[0])
         else:
             return "Failed to authenticate with host."
diff --git a/signac/common/host.py b/signac/common/host.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import logging
 import warnings
 import getpass

diff --git a/signac/common/validate.py b/signac/common/validate.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import logging
 
 from .configobj.validate import Validator

diff --git a/signac/contrib/__init__.py b/signac/contrib/__init__.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 from __future__ import absolute_import
 import warnings
 

diff --git a/signac/contrib/adapters.py b/signac/contrib/adapters.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 from . import conversion
 from .formats import FileFormat
 

diff --git a/signac/contrib/conversion.py b/signac/contrib/conversion.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import logging
 
 from ..common.six import with_metaclass

diff --git a/signac/contrib/crawler.py b/signac/contrib/crawler.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import os
 import re
 import json

diff --git a/signac/contrib/errors.py b/signac/contrib/errors.py
@@ -1,6 +1,8 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
+
+
 class DatabaseError(BaseException):
     pass
 

diff --git a/signac/contrib/filesystems.py b/signac/contrib/filesystems.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 """The file system handlers defined in this module
 encapsulate the I/O operations required to store
 and fetch data from different file systems."""

diff --git a/signac/contrib/formats.py b/signac/contrib/formats.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import logging
 import errno
 

diff --git a/signac/contrib/formats_network.py b/signac/contrib/formats_network.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import logging
 import inspect
 import collections

diff --git a/signac/contrib/hashing.py b/signac/contrib/hashing.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import hashlib
 import json
 

diff --git a/signac/contrib/job.py b/signac/contrib/job.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import os
 import errno
 import logging

diff --git a/signac/contrib/project.py b/signac/contrib/project.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import os
 import re
 import logging
@@ -162,8 +162,9 @@ def find_statepoints(self, filter=None, skip_errors=False):
 
         :param filter: If not None, only yield statepoints matching the filter.
         :type filter: mapping
-        :param skip_errors: Show, but otherwise ignore errors while iterating
-            over the workspace. Use this argument to repair a corrupted workspace.
+        :param skip_errors: Show, but otherwise ignore errors while
+            iterating over the workspace. Use this argument to repair
+            a corrupted workspace.
         :type skip_erros: bool
         :yields: statepoints as dict"""
         filter = None if filter is None else json.loads(json.dumps(filter))

diff --git a/signac/contrib/utility.py b/signac/contrib/utility.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import logging
 import sys
 import os

diff --git a/signac/core/__init__.py b/signac/core/__init__.py
@@ -1,3 +1,3 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
diff --git a/signac/core/jsondict.py b/signac/core/jsondict.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 "Dict implementation with backend json file."
 import os
 import errno

diff --git a/signac/core/utility.py b/signac/core/utility.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import re
 import subprocess
 

diff --git a/signac/db/__init__.py b/signac/db/__init__.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 import logging
 import warnings
 try:

diff --git a/signac/db/database.py b/signac/db/database.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 from ..common import host
 
 

diff --git a/signac/gui/__init__.py b/signac/gui/__init__.py
@@ -1,6 +1,6 @@
 # Copyright (c) 2016 The Regents of the University of Michigan
 # All rights reserved.
-# This software is licensed under the MIT License.
+# This software is licensed under the BSD 3-Clause License.
 """Graphical User Interface (GUI) for configuration and database inspection.
 
 The GUI is a leight-weight interface which makes the configuration