Generate new project

jacebrowning · Jun 9, 2016 · 41682eb · 41682eb
commit 41682eb
Show file tree

Hide file tree

Showing 34 changed files with 1,206 additions and 0 deletions.
diff --git a/.appveyor.yml b/.appveyor.yml
@@ -0,0 +1,28 @@
+environment:
+  global:
+    RANDOM_SEED: 12345
+  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 dependencies
+  - make depends-ci
+
+build: off
+
+test_script:
+  - make ci
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,5 @@
+[run]
+branch = true
+omit =
+    */env/*
+    */tests/*
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+* text=auto
+CHANGELOG.md merge=union
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,49 @@
+# 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
+/apidocs
+/site
+/*.html
+/*.rst
+/docs/*.png
+
+# Google Drive
+*.gdoc
+*.gsheet
+*.gslides
+*.gdraw
+
+# Testing and coverage results
+.cache
+.pytest
+.coverage
+.coverage.*
+/htmlcov
+/pyunit.xml
+*.tmp
+
+# Build and release directories
+/build
+/dist
+
+# Sublime Text
+*.sublime-workspace
+
+# Eclipse
+.settings
diff --git a/.pep257 b/.pep257
@@ -0,0 +1,8 @@
+[pep257]
+
+# D211: No blank lines allowed before class docstring
+add_select = D211
+
+# D105: Missing docstring in magic method
+# D202: No blank lines allowed after function docstring
+add_ignore = D105,D202
diff --git a/.pep8rc b/.pep8rc
@@ -0,0 +1,6 @@
+[pep8]
+
+# 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
diff --git a/.project b/.project
@@ -0,0 +1,109 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>sappy</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.python.pydev.PyDevBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.python.pydev.pythonNature</nature>
+	</natures>
+	<filteredResources>
+		<filter>
+			<id>1398478527151</id>
+			<name></name>
+			<type>26</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-false-false-__pycache__</arguments>
+			</matcher>
+		</filter>
+		<filter>
+			<id>1398478527152</id>
+			<name></name>
+			<type>26</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-false-false-*.egg-info</arguments>
+			</matcher>
+		</filter>
+		<filter>
+			<id>1398478527153</id>
+			<name></name>
+			<type>26</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-false-false-env</arguments>
+			</matcher>
+		</filter>
+		<filter>
+			<id>1398478527154</id>
+			<name></name>
+			<type>22</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-false-false-README.rst</arguments>
+			</matcher>
+		</filter>
+		<filter>
+			<id>1398478527155</id>
+			<name></name>
+			<type>26</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-false-false-apidocs</arguments>
+			</matcher>
+		</filter>
+		<filter>
+			<id>1398478527156</id>
+			<name></name>
+			<type>22</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-false-false-*.sublime-*</arguments>
+			</matcher>
+		</filter>
+		<filter>
+			<id>1398478527157</id>
+			<name></name>
+			<type>22</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-false-false-README*.html</arguments>
+			</matcher>
+		</filter>
+		<filter>
+			<id>1398478527158</id>
+			<name></name>
+			<type>26</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-false-false-build</arguments>
+			</matcher>
+		</filter>
+		<filter>
+			<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
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<?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">sappy</pydev_property>
+<pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH">
+<path>/${PROJECT_DIR_NAME}</path>
+</pydev_pathproperty>
+</pydev_project>
diff --git a/.pylintrc b/.pylintrc
@@ -0,0 +1,15 @@
+[MESSAGES CONTROL]
+
+disable=locally-disabled,fixme,too-few-public-methods,too-many-public-methods,invalid-name,global-statement,too-many-ancestors
+
+[FORMAT]
+
+max-line-length=80
+
+ignore-long-lines=^.*((https?:)|(pragma:)|(TODO:)).*$
+
+[REPORTS]
+
+reports=no
+
+msg-template={msg_id} ({symbol}):{line:3d},{column}: {msg}
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -0,0 +1,9 @@
+checks:
+    python:
+        code_rating: true
+        duplicate_code: true
+tools:
+    external_code_coverage: true
+    pylint:
+        python_version: 3
+        config_file: '.pylintrc'
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,56 @@
+sudo: false
+
+language: python
+python:
+- 2.7
+- 3.3
+- 3.4
+- 3.5
+
+cache:
+  pip: true
+  directories:
+  - env
+
+env:
+  global:
+  - RANDOM_SEED=12345
+  # TODO: change this token: http://benlimmer.com/2013/12/26/automatically-publish-javadoc-to-gh-pages-with-travis-ci/
+  - secure: "C47GeEhpKhKZ/VUH6zXX+drGw9HdZt05thVikBUhXY8UbdbujVsjG5z8w7/GMpCmHIVKrijxQ5ZCF3HSSk/VBHMHPIR9AtYg3gOjuBmzNuhinYgC6JH7fZdDlDUKOU2U92h8gl0j/6CYIkLhPF211bpc6mSeOfSEIdz3YMcpvvc="
+
+install:
+- pip install coveralls scrutinizer-ocular
+
+before_script:
+- make env
+- make depends-ci
+
+script:
+- make ci
+
+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 "travis@travis-ci.org" ;
+    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
+    on_failure: change
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Revision History
+
+## 0.0.0 (YYYY/MM/DD)
+
+ - TBD
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,75 @@
+# For Contributors
+
+## Setup
+
+### Requirements
+
+* Make:
+    * Windows: http://cygwin.com/install.html
+    * Mac: https://developer.apple.com/xcode
+    * Linux: http://www.gnu.org/software/make (likely already installed)
+* Pandoc: http://johnmacfarlane.net/pandoc/installing.html
+* Graphviz: http://www.graphviz.org/Download.php
+
+### Installation
+
+Create a virtual environment:
+
+```
+$ make env
+```
+
+## Development Tasks
+
+### Testing
+
+Manually run the tests:
+
+```
+$ make test
+$ make tests  # includes integration tests
+```
+
+or keep them running on change:
+
+```
+$ make watch
+```
+
+> In order to have OS X notifications, `brew install terminal-notifier`.
+
+### Documentation
+
+Build the documentation:
+
+```
+$ make doc
+```
+
+### Static Analysis
+
+Run linters and static analyzers:
+
+```
+$ make pep8
+$ make pep257
+$ make pylint
+$ make check  # includes all checks
+```
+
+## Continuous Integration
+
+The CI server will report overall build status:
+
+```
+$ make ci
+```
+
+## Release Tasks
+
+Release to PyPI:
+
+```
+$ make upload-test  # dry run upload to a test server
+$ make upload
+```