Merge pull request #124 from jacebrowning/release/v1.0.2

Release v1.0.2

.coveragerc

@@ -2,4 +2,4 @@
 branch = true
 omit =
     */env/*
-    */test/*
+    */tests/*

.gitignore

@@ -1,4 +1,4 @@
-*/test/files/src
+*/tests/files/gitman_sources
 
 # Temporary Python files
 *.pyc
@@ -19,7 +19,7 @@ Icon*
 
 # Generated documentation
 /docs/gen
-/apidocs
+/docs/apidocs
 /site
 /*.html
 /*.rst

.pep257

@@ -3,8 +3,11 @@
 # D211: No blank lines allowed before class docstring
 add_select = D211
 
+# D100: Missing docstring in public module
+# D101: Missing docstring in public class
 # D102: Missing docstring in public method
 # D103: Missing docstring in public function
+# D104: Missing docstring in public package
 # D105: Missing docstring in magic method
 # D202: No blank lines allowed after function docstring
-add_ignore = D102,D103,D105,D202
+add_ignore = D100,D101,D102,D103,D104,D105,D202

.pep8rc

@@ -1,3 +1,6 @@
 [pep8]
 
-ignore = E501,E712
+# E501: line too long (checked by PyLint)
+# E711: comparison to None (used to improve test style)
+# E712: comparison to True (used to improve test style)
+ignore = E501,E711,E712

.pylintrc

@@ -1,6 +1,6 @@
 [MESSAGES CONTROL]
 
-disable=locally-disabled,fixme,too-few-public-methods,too-many-public-methods,invalid-name,global-statement,too-many-ancestors,misplaced-comparison-constant,missing-docstring
+disable=locally-disabled,fixme,too-few-public-methods,too-many-public-methods,invalid-name,global-statement,too-many-ancestors,missing-docstring
 
 [FORMAT]
 

.travis.yml

@@ -12,40 +12,22 @@ cache:
 env:
   global:
   - RANDOM_SEED=12345
-  - secure: "UnyHAJ/T6eI/6vaXXKsZgs2XqBib06DubRqMVegy1nMNBjFsmyZ3tU+22gW2NWAGzukwC3GXWsxkN+7sTlTcTldFBvN9onzC1oVDfQrcAUjvSOK02OZ4tepVq5umsDUxGpRqhWB7LgEv0zM6DHzj6k+yaPBtcJg6NFhpScQfHyY="
 
 install:
 - pip install coveralls scrutinizer-ocular
 
 before_script:
 - make env
-- make depends-ci
+- make depends
 
 script:
-- make ci
+- make check
+- make test
 
 after_success:
 - coveralls
 - ocular
 
-after_script: >
-  echo $TRAVIS_BRANCH; echo $TRAVIS_PULL_REQUEST;
-  if [[ $TRAVIS_BRANCH == 'develop' && $TRAVIS_PULL_REQUEST == 'false' ]]; then
-    # Generate site
-    make mkdocs ;
-    # Configure Git with Travis CI information
-    git config --global user.email "[email protected]" ;
-    git config --global user.name "travis-ci" ;
-    # Delete the current repository
-    rm -rf .git ;
-    # Rebuild the repository from the generated files and push to GitHub pages
-    cd site ;
-    git init ;
-    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

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Revision History
 
+## 1.0.2 (2016/07/28)
+
+- Moved documentation to http://gitman.readthedocs.io/.
+
 ## 1.0.1 (2016/05/31)
 
 - Replaced calls to `git remote add origin` with `git remote set-url origin`.

CONTRIBUTING.md

@@ -8,32 +8,31 @@
     * 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:
+Create a virtual environment:
 
-```sh
+```
 $ make env
 ```
 
-## Development
+## Development Tasks
 
 ### Testing
 
 Manually run the tests:
 
-```sh
+```
 $ make test
 $ make tests  # includes integration tests
 ```
 
 or keep them running on change:
 
-```sh
+```
 $ make watch
 ```
 
@@ -43,26 +42,34 @@ $ make watch
 
 Build the documentation:
 
-```sh
+```
 $ make doc
 ```
 
 ### Static Analysis
 
 Run linters and static analyzers:
 
-```sh
+```
 $ make pep8
 $ make pep257
 $ make pylint
 $ make check  # includes all checks
 ```
 
-## Release
+## Continuous Integration
+
+The CI server will report overall build status:
+
+```
+$ make ci
+```
+
+## Release Tasks
 
 Release to PyPI:
 
-```sh
+```
 $ make upload-test  # dry run upload to a test server
 $ make upload
 ```