Skip to content

Commit

Permalink
Update project structure
Browse files Browse the repository at this point in the history
  • Loading branch information
jacebrowning committed Jan 9, 2017
1 parent a43e607 commit 535e260
Show file tree
Hide file tree
Showing 16 changed files with 412 additions and 149 deletions.
7 changes: 4 additions & 3 deletions .appveyor.yml
@@ -1,6 +1,6 @@
environment:
global:
RANDOM_SEED: 12345
RANDOM_SEED: 0
matrix:
- PYTHON_MAJOR: 3
PYTHON_MINOR: 5
Expand All @@ -13,9 +13,10 @@ install:
- copy C:\MinGW\bin\mingw32-make.exe C:\MinGW\bin\make.exe
- set PATH=%PATH%;C:\MinGW\bin
- make --version
# Check system dependencies
- make doctor
# Install project dependencies
- make env
- make depends
- make install

build: off

Expand Down
2 changes: 1 addition & 1 deletion .pep8rc → .pycodestyle.ini
@@ -1,4 +1,4 @@
[pep8]
[pycodestyle]

# E501: line too long (checked by PyLint)
# E711: comparison to None (used to improve test style)
Expand Down
2 changes: 1 addition & 1 deletion .pep257 → .pydocstyle
@@ -1,4 +1,4 @@
[pep257]
[pydocstyle]

# D211: No blank lines allowed before class docstring
add_select = D211
Expand Down
File renamed without changes.
17 changes: 10 additions & 7 deletions .scrutinizer.yml
@@ -1,9 +1,12 @@
checks:
python:
code_rating: true
duplicate_code: true
python:
code_rating: true
duplicate_code: true
tools:
external_code_coverage: true
pylint:
python_version: 3
config_file: '.pylintrc'
external_code_coverage: true
pylint:
python_version: 3
config_file: '.pylintrc'
filter:
excluded_paths:
- "*/tests/*"
26 changes: 13 additions & 13 deletions .travis.yml
@@ -1,32 +1,32 @@
language: python
python:
- 3.5
- 3.5

cache:
pip: true
directories:
- env
- ~/virtualenv/python3.5.*

env:
global:
- RANDOM_SEED=12345
- RANDOM_SEED=0

install:
- pip install coveralls scrutinizer-ocular
before_install:
- make doctor

before_script:
- make env
- make depends
install:
- make install

script:
- make check
- make test
- make check
- make test

after_success:
- coveralls
- ocular
- pip install coveralls scrutinizer-ocular
- coveralls
- ocular

notifications:
email:
on_success: never
on_failure: change
on_failure: never
34 changes: 34 additions & 0 deletions .verchew.ini
@@ -0,0 +1,34 @@
[Make]

cli = make

version = GNU Make


[Python]

cli = python

version = Python 3.


[virtualenv]

cli = virtualenv

version = 15.


[pandoc]

cli = pandoc

version = 1.


[Graphviz]

cli = dot
cli_version_arg = -V

version = 2.
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
Expand Up @@ -5,18 +5,24 @@
### Requirements

* Make:
* Windows: http://cygwin.com/install.html
* Windows: https://cygwin.com/install.html
* Mac: https://developer.apple.com/xcode
* Linux: http://www.gnu.org/software/make (likely already installed)
* Linux: https://www.gnu.org/software/make (likely already installed)
* Pandoc: http://johnmacfarlane.net/pandoc/installing.html
* Graphviz: http://www.graphviz.org/Download.php

To confirm these system dependencies are configured correctly:

```sh
$ make doctor
```

### Installation

Create a virtual environment:
Install project dependencies into a virtual environment:

```sh
$ make env
$ make install
```

## Development Tasks
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Expand Up @@ -2,7 +2,7 @@

**The MIT License (MIT)**

Copyright © 2016, Jace Browning
Copyright © 2017, 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
Expand Down

0 comments on commit 535e260

Please sign in to comment.