Merge pull request #76 from jacebrowning/plumbing/project-structure-u…

…pdates

Project structure updates

.gitignore

@@ -25,6 +25,7 @@ docs/*.png
 *.gdraw
 
 # Testing and coverage results
+.pytest
 .coverage
 htmlcov
 pyunit.xml

.pep8rc

@@ -0,0 +1,2 @@
+[pep8]
+ignore = E501

.project

@@ -96,5 +96,14 @@
 				<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>

.travis.yml

@@ -1,18 +1,26 @@
 sudo: false
+
 language: python
 python:
 - 3.3
 - 3.4
+
+cache: pip
+
 install:
 - pip install coveralls scrutinizer-ocular
+
 before_script:
 - make env
 - make depends-ci
+
 script:
 - make ci
+
 after_success:
 - coveralls
 - ocular
+
 notifications:
   email:
     on_success: never

CHANGES.md

@@ -1,14 +1,11 @@
-Changelog
-=========
+# Revision History
 
-0.4.1 (2015-06/19)
-------------------
+## 0.4.1 (2015-06/19)
 
 - Fixed attribute loss in non-`dict` when conversion to `dict`.
 - Now automatically adding missing attributes to mapped objects.
 
-0.4 (2015-05-16)
-----------------
+## 0.4 (2015-05-16)
 
 - Moved all converters into the `yorm.converters` package.
 - Renamed `container` to `containers`.
@@ -17,18 +14,15 @@ Changelog
 - Removed the context manager in mapped objects.
 - Fixed automatic mapping of nested attributes.
 
-0.3.2 (2015-04-07)
-------------------
+## 0.3.2 (2015-04-07)
 
 - Fixed object overwrite when calling `utilities.update`.
 
-0.3.1 (2015-04-06)
-------------------
+## 0.3.1 (2015-04-06)
 
 - Fixed infinite recursion with properties that rely on other mapped attributes.
 
-0.3 (2015-03-10)
-----------------
+## 0.3 (2015-03-10)
 
 - Updated mapped objects to only read from the filesystem if there are changes.
 - Renamed `store` to `sync_object`.
@@ -38,28 +32,24 @@ Changelog
 - Added `update_object` and `update_file` to force syncrhonization.
 - Added `update` to call `update_object` and/or `update_file` as needed.
 
-0.2.1 (2015-02-12)
-------------------
+## 0.2.1 (2015-02-12)
 
 - Container types now extend their builtin type.
 - Added `None<Type>` extended types with `None` as a default.
 - Added `AttributeDictionary` with keys available as attributes.
 - Added `SortedList` that sorts when dumped.
 
-0.2 (2014-11-30)
-----------------
+## 0.2 (2014-11-30)
 
 - Allowing `map_attr` and `store` to be used together.
 - Allowing `Dictionary` containers to be used as attributes.
 - Fixed method resolution order for modified classes.
 - Added a `yorm.settings.fake` option to bypass the filesystem.
 
-0.1.1 (2014-10-20)
-------------------
+## 0.1.1 (2014-10-20)
 
 - Fixed typos in examples.
 
-0.1 (2014-09-29)
-----------------
+## 0.1 (2014-09-29)
 
  - Initial release.

CONTRIBUTING.md

@@ -1,8 +1,8 @@
-For Contributors
-================
+# For Contributors
 
-Requirements
-------------
+## Setup
+
+### Requirements
 
 * Make:
     * Windows: http://cygwin.com/install.html
@@ -12,29 +12,44 @@ Requirements
 * Pandoc: http://johnmacfarlane.net/pandoc/installing.html
 * Graphviz: http://www.graphviz.org/Download.php
 
-Installation
-------------
+### Installation
 
 Create a virtualenv:
 
 ```
 $ make env
 ```
 
-Run the tests:
+## Development
+
+### 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
 ```
 
-Run static analysis:
+### Static Analysis
+
+Run linters and static analyzers:
 
 ```
 $ make pep8
@@ -43,9 +58,11 @@ $ make pylint
 $ make check  # includes all checks
 ```
 
-Prepare a release:
+## Release
+
+Release to PyPI:
 
 ```
-$ make dist  # dry run
+$ make upload-test  # dry run upload to a test server
 $ make upload
 ```