Merge pull request #203 from jacebrowning/release/v1.0

Release v1.0
doorstop-dev · Apr 18, 2016 · df64f3e · df64f3e
2 parents f8f56ca + bf258b9
commit df64f3e
Show file tree

Hide file tree

Showing 88 changed files with 850 additions and 450 deletions.
diff --git a/.coveragerc b/.coveragerc
@@ -1,4 +1,5 @@
 [run]
+branch = true
 omit =
     */env/*
     */test/*
diff --git a/.gitattributes b/.gitattributes
@@ -1,4 +1,7 @@
 * text=auto
+CHANGES.md merge=union
+
+*.xlsx binary
 
 # Python, Git, and Cygwin have different ideas about the correct line endings
 *.yml  -text
@@ -7,5 +10,3 @@
 *.html -text
 *.csv  -text
 *.tsv  -text
-
-*.xlsx binary
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 *.pyc
 *.egg-info
 __pycache__
+.ipynb_checkpoints
 
 # Temporary OS files
 Icon*
@@ -13,7 +14,7 @@ env
 # Generated documentation
 docs/gen
 apidocs
-docs/*.html
+/*.html
 *.rst
 docs/*.png
 docs/sphinx/_build
@@ -28,6 +29,8 @@ pages/reqs/
 
 # Testing and coverage results
 .coverage
+htmlcov
+pyunit.xml
 
 # Build and release directories
 build

diff --git a/.noserc b/.noserc
@@ -9,7 +9,6 @@ cover-package=doorstop.common,doorstop.core,
     doorstop.cli.main,doorstop.cli.utilities,
     doorstop.gui,doorstop.server
 cover-erase=1
-cover-min-percentage=100
 
 verbosity=1
 logging-level=DEBUG

diff --git a/.pep257 b/.pep257
@@ -0,0 +1,5 @@
+[pep257]
+
+# D10*: Missing docstring (checked by PyLint)
+# D202: No blank lines allowed *after* function docstring (personal preference)
+add-ignore = D102,D105,D202
diff --git a/.project b/.project
@@ -16,7 +16,7 @@
 	</natures>
 	<filteredResources>
 		<filter>
-			<id>1399387763933</id>
+			<id>1398478527151</id>
 			<name></name>
 			<type>26</type>
 			<matcher>
@@ -25,7 +25,7 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1399387763939</id>
+			<id>1398478527152</id>
 			<name></name>
 			<type>26</type>
 			<matcher>
@@ -34,7 +34,7 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1399387763945</id>
+			<id>1398478527153</id>
 			<name></name>
 			<type>26</type>
 			<matcher>
@@ -43,7 +43,7 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1399387763951</id>
+			<id>1398478527154</id>
 			<name></name>
 			<type>22</type>
 			<matcher>
@@ -52,7 +52,7 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1399387763956</id>
+			<id>1398478527155</id>
 			<name></name>
 			<type>26</type>
 			<matcher>
@@ -61,7 +61,7 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1399387763962</id>
+			<id>1398478527156</id>
 			<name></name>
 			<type>22</type>
 			<matcher>
@@ -70,7 +70,7 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1399387763968</id>
+			<id>1398478527157</id>
 			<name></name>
 			<type>22</type>
 			<matcher>
@@ -79,7 +79,7 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1399387763974</id>
+			<id>1398478527158</id>
 			<name></name>
 			<type>26</type>
 			<matcher>
@@ -88,13 +88,22 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1399387763981</id>
+			<id>1398478527159</id>
 			<name></name>
 			<type>26</type>
 			<matcher>
 				<id>org.eclipse.ui.ide.multiFilter</id>
 				<arguments>1.0-name-matches-false-false-dist</arguments>
 			</matcher>
 		</filter>
+		<filter>
+			<id>1429034866152</id>
+			<name></name>
+			<type>26</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-false-false-htmlcov</arguments>
+			</matcher>
+		</filter>
 	</filteredResources>
 </projectDescription>
diff --git a/.pydevproject b/.pydevproject
@@ -2,8 +2,6 @@
 <?eclipse-pydev version="1.0"?><pydev_project>
 <pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 3.0</pydev_property>
 <pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Doorstop</pydev_property>
-
-
 <pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH">
 <path>/${PROJECT_DIR_NAME}</path>
 </pydev_pathproperty>

diff --git a/.pylintrc b/.pylintrc
@@ -19,6 +19,6 @@ msg-template={msg_id}:{line:3d},{column}:{msg}
 
 [FORMAT]
 
-max-line-length=79
+max-line-length=80
 
-ignore-long-lines=^.*#+.*((https?:)|(pragma:)|(TODO:)).*$
+ignore-long-lines=^.*((https?:)|(pragma:)|(TODO:)).*$
diff --git a/.travis.yml b/.travis.yml
@@ -1,18 +1,33 @@
+sudo: false
+
 language: python
 python:
 - 3.3
 - 3.4
-git:
-  depth: 1
+- 3.5
+
+env:
+  global:
+    # Encrypted GH_TOKEN token: http://benlimmer.com/2013/12/26/automatically-publish-javadoc-to-gh-pages-with-travis-ci
+    secure: JfVl6zxzhRIEG1VvLqMEPMGOecrzDyb2U0HPyQ4Z4pfKJgFJOdQ1orT9Aztpfr4edXqbCZnEy4WH8+FLBQagkXjT3Ladopv+9j1IkP8v1Gu1O8H2tHQc7wfGxnkQF+h0pFFS6adNAsMliQ5dxTojFYVoWebvZQbiVGYkew+QZ0c=
+
 install:
 - pip install coveralls scrutinizer-ocular
-script: make ci
+
+before_script:
+- make env
+- make depends-ci
+
+script:
+- make ci
+
 after_success:
 - coveralls
 - ocular
+
 after_script: >
   echo $TRAVIS_BRANCH; echo $TRAVIS_PULL_REQUEST; echo $TRAVIS_PYTHON_VERSION;
-  if [[ $TRAVIS_BRANCH == 'master' && $TRAVIS_PULL_REQUEST == 'false' && $TRAVIS_PYTHON_VERSION == '3.3' ]]; then
+  if [[ $TRAVIS_BRANCH == 'develop' && $TRAVIS_PULL_REQUEST == 'false' && $TRAVIS_PYTHON_VERSION == '3.3' ]]; then
 
     # Generate Doorstop and Sphinx HTML pages
     make pages ;
@@ -32,12 +47,10 @@ after_script: >
     git add . ;
     git commit -m "Deploy Travis CI build $TRAVIS_BUILD_NUMBER to GitHub pages" ;
     git push -f https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG} master:gh-pages ;
+
   fi
+
 notifications:
   email:
     on_success: never
-    on_failure: always
-env:
-  global:
-    # Encrypted GH_TOKEN token: http://benlimmer.com/2013/12/26/automatically-publish-javadoc-to-gh-pages-with-travis-ci
-    secure: JfVl6zxzhRIEG1VvLqMEPMGOecrzDyb2U0HPyQ4Z4pfKJgFJOdQ1orT9Aztpfr4edXqbCZnEy4WH8+FLBQagkXjT3Ladopv+9j1IkP8v1Gu1O8H2tHQc7wfGxnkQF+h0pFFS6adNAsMliQ5dxTojFYVoWebvZQbiVGYkew+QZ0c=
+    on_failure: change
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,13 @@
-Changelog
-=========
+Revision History
+================
+
+1.0 (2016/04/17)
+----------------
+
+- Fixed a bug checking levels across inactive items.
+- Added error message for all IO errors.
+- Added '--skip' options to disable documents during validation.
+- Added Mercurial support. (credit: [@tjasz](https://github.com/tjasz))
 
 0.8.4 (2015/03/12)
 ------------------

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,51 @@
+For Contributors
+================
+
+Requirements
+------------
+
+* Make:
+    * Windows: http://cygwin.com/install.html
+    * Mac: https://developer.apple.com/xcode
+    * Linux: http://www.gnu.org/software/make (likely already installed)
+* virtualenv: https://pypi.python.org/pypi/virtualenv#installation
+* Pandoc: http://johnmacfarlane.net/pandoc/installing.html
+* Graphviz: http://www.graphviz.org/Download.php
+
+Installation
+------------
+
+Create a virtualenv:
+
+```
+$ make env
+```
+
+Run the tests:
+
+```
+$ make test
+$ make tests  # includes integration tests
+```
+
+Build the documentation:
+
+```
+$ make doc
+```
+
+Run static analysis:
+
+```
+$ make pep8
+$ make pep257
+$ make pylint
+$ make check  # includes all checks
+```
+
+Release to PyPI:
+
+```
+$ make upload-test  # dry run upload to a test server
+$ make upload
+```