-
Notifications
You must be signed in to change notification settings - Fork 134
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update project structure from template
- Loading branch information
1 parent
39bca27
commit 9183b09
Showing
11 changed files
with
149 additions
and
116 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
sudo: false | ||
language: python | ||
python: | ||
- 3.3 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |
Oops, something went wrong.