Generate new project

.appveyor.yml

@@ -0,0 +1,29 @@
+environment:
+  global:
+    RANDOM_SEED: 0
+  matrix:
+    - PYTHON_MAJOR: 2
+      PYTHON_MINOR: 7
+    - PYTHON_MAJOR: 3
+      PYTHON_MINOR: 3
+    - PYTHON_MAJOR: 3
+      PYTHON_MINOR: 4
+    - PYTHON_MAJOR: 3
+      PYTHON_MINOR: 5
+
+cache:
+  - env
+
+install:
+  # Export build paths
+  - copy C:\MinGW\bin\mingw32-make.exe C:\MinGW\bin\make.exe
+  - set PATH=%PATH%;C:\MinGW\bin
+  - make --version
+  # Install project dependencies
+  - make install
+
+build: off
+
+test_script:
+  - make check
+  - make test

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+branch = true
+omit =
+    */env/*
+    */tests/*

.gitattributes

@@ -0,0 +1,2 @@
+* text=auto
+CHANGELOG.md merge=union

.gitignore

@@ -0,0 +1,51 @@
+# Temporary Python files
+*.pyc
+*.egg-info
+__pycache__
+.ipynb_checkpoints
+
+# Temporary OS files
+Icon*
+
+# Temporary virtual environment files
+.cache
+/env
+
+# Temporary server files
+.env
+*.pid
+
+# Generated documentation
+/docs/gen
+/docs/apidocs
+/site
+/*.html
+/*.rst
+/docs/*.png
+
+# Google Drive
+*.gdoc
+*.gsheet
+*.gslides
+*.gdraw
+
+# Testing and coverage results
+.cache
+.pytest
+.coverage
+.coverage.*
+/htmlcov
+/xmlreport
+/pyunit.xml
+*.tmp
+
+# Build and release directories
+*.spec
+/build
+/dist
+
+# Sublime Text
+*.sublime-workspace
+
+# Eclipse
+.settings

.pep257

@@ -0,0 +1,13 @@
+[pep257]
+
+# 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 = D100,D101,D102,D103,D104,D105,D202

.pep8rc

@@ -0,0 +1,7 @@
+[pep8]
+
+# E402 module level import not at top of file (checked by PyLint)
+# 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 = E402,E501,E711,E712

.pylintrc

@@ -0,0 +1,21 @@
+[MESSAGES CONTROL]
+
+disable=locally-disabled,fixme,too-few-public-methods,too-many-public-methods,invalid-name,global-statement,too-many-ancestors,missing-docstring
+
+[FORMAT]
+
+max-line-length=80
+
+ignore-long-lines=^.*((https?:)|(pragma:)|(TODO:)).*$
+
+[SIMILARITIES]
+
+min-similarity-lines=4
+
+ignore-imports=yes
+
+[REPORTS]
+
+reports=no
+
+msg-template={msg_id} ({symbol}):{line:3d},{column}: {msg}

.scrutinizer.yml

@@ -0,0 +1,9 @@
+checks:
+    python:
+        code_rating: true
+        duplicate_code: true
+tools:
+    external_code_coverage: true
+    pylint:
+        python_version: 2
+        config_file: '.pylintrc'

.travis.yml

@@ -0,0 +1,32 @@
+language: python
+python:
+  - 2.7
+  - 3.3
+  - 3.4
+  - 3.5
+
+cache:
+  pip: true
+  directories:
+    - env
+
+env:
+  global:
+    - RANDOM_SEED=0
+
+install:
+  - make install
+
+script:
+  - make check
+  - make test
+
+after_success:
+  - pip install coveralls scrutinizer-ocular
+  - coveralls
+  - ocular
+
+notifications:
+  email:
+    on_success: never
+    on_failure: change

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Revision History
+
+## 0.0.0 (YYYY/MM/DD)
+
+ - TBD

CONTRIBUTING.md

@@ -0,0 +1,76 @@
+# For Contributors
+
+## Setup
+
+### Requirements
+
+* Make:
+    * Windows: https://cygwin.com/install.html
+    * Mac: https://developer.apple.com/xcode
+    * Linux: https://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
+
+Install project dependencies into a virtual environment:
+
+```sh
+$ make install
+```
+
+## Development Tasks
+
+### Testing
+
+Manually run the tests:
+
+```sh
+$ make test
+$ make tests  # includes integration tests
+```
+
+or keep them running on change:
+
+```sh
+$ make watch
+```
+
+> In order to have OS X notifications, `brew install terminal-notifier`.
+
+### Documentation
+
+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
+```
+
+## Continuous Integration
+
+The CI server will report overall build status:
+
+```sh
+$ make ci
+```
+
+## Release Tasks
+
+Release to PyPI:
+
+```sh
+$ make upload-test  # dry run upload to a test server
+$ make upload
+```

LICENSE.md

@@ -0,0 +1,23 @@
+# License
+
+**The MIT License (MIT)**
+
+Copyright © 2016, Jace Browning
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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.

MANIFEST.in

@@ -0,0 +1,4 @@
+include *.rst *.txt *.md
+recursive-include docs *.rst *.txt *.md
+graft */files
+graft */*/files