Merge branch 'release/0.2.0'

Author: wcooley

HISTORY.rst

@@ -3,7 +3,13 @@
 History
 -------
 
+0.2.0 (2016-07-05)
+++++++++++++++++++
+
+* Initial implementation of working constructors with some basic testing.
+
 0.1.0 (2015-11-11)
 ++++++++++++++++++
 
-* First release on PyPI.
+* First tagged release. No working code, just ideas of what the YAML might look
+  like. Not released on PyPI.

README.rst

@@ -20,35 +20,40 @@ Features
 --------
 
 * Creates nodes and relationships in a Neo4j graph database from YAML using
-PyYAML-specific tags.
+  PyYAML-specific tags.
 * Operates at a whole-file level, as it uses custom YAML tags to deserialize
-the data to live objects.
+  the data to live objects.
 * Developed for loading data for integration testing.
 * Requires a running Neo4j instance and instantiates actual database entities,
-rather than just generating abstract/unbound :class:`py2neo.Node` and
-:class:`py2neo.Relationship` objects. This is due to :mod:`py2neo` version 1.6
-not supporting node labels with abstract nodes. This might be changed if we
-are able to migrate off of 1.6 in the near future.
+  rather than just generating abstract/unbound :class:`py2neo.Node` and
+  :class:`py2neo.Relationship` objects. This is due to :mod:`py2neo` version
+  1.6 not supporting node labels with abstract nodes. This might be changed if
+  we are able to migrate off of 1.6 in the near future.
 
 Versions
 --------
 
-* Neo4j: Should work with anything >= 2.0 but < 3. Tested with 2.3.2. Running
-the tests requires 2.3 as it uses the `DETACH DELETE` feature to drop the
-database.
-* :mod:`py2neo`: Currently only supports 2.0. Expecting to do 3; dreading 1.6.
-* :mod:`pyyaml`: Only tested with PyYAML v3.11, the last release since 2014.
+Python
+    Tested with both Python 2.7 and 3.5.
+Neo4j
+    Should work with anything >= 2.0 but < 3. Tested with 2.3.2. Running the
+    tests requires 2.3 as it uses the ``DETACH DELETE`` feature to drop the
+    database.
+:mod:`py2neo`
+    Currently only supports 2.0. Expecting to do 3; dreading 1.6.
+:mod:`pyyaml`
+    Only tested with PyYAML v3.11, the last release since 2014.
 
 Testing
 -------
 
-* Running the tests requires an installed, running Neo4j instance.
-Pass the URL through the environment variable `NEO4J_URI`.
+Running the tests requires an installed, running Neo4j instance. Pass the URL
+through the environment variable ``NEO4J_URI``.
 
 Future
 ------
 
 * Custom YAML representer & constructor. Currently it is not possible to
-automatically dump Node and Relationship objects in a reasonable fashion.
+  automatically dump Node and Relationship objects in a reasonable fashion.
 * `py2neo` & Neo4j v3 support.
-* Documentation, etc
+* Documentation, etc.

docs/usage.rst

@@ -2,6 +2,50 @@
 Usage
 ========
 
-To use Python Gryaml in a project::
 
-	import gryaml
+Nodes & relationships can be created automatically in a Neo4j database upon
+load using the ``!!python/object/apply`` YAML
+`tag <http://pyyaml.org/wiki/PyYAMLDocumentation#Objects>`_ with PyYAML.
+
+#. A connection to the graph database needs to be established using
+   ``gryaml.connect(uri=URI)`` or ``gryaml.connect(graph=py2neo.Graph(...))``.
+   This stores the graph handle in the global module namespace because it is not
+   possible to pass in a handle to the constructors otherwise.
+
+   ::
+
+       import gryaml
+
+       gryaml.connect('http://localhost:7474')
+
+#. Import :mod:`pyyaml` and load the data:
+
+   ::
+
+        import yaml
+        yaml.load("""
+        - &node-foo !!python/object/apply:gryaml.node
+          - labels:
+            - 'Fooer'
+          - properties:
+            prop1: 'flim'
+        - &node-bar !!python/object/apply:gryaml.node
+          - labels:
+            - 'Barer'
+          - properties:
+            prop1: 'flam'
+        - !!python/object/apply:gryaml.rel
+          - *node-foo
+          - 'RELATES_TO'
+          - *node-bar
+          - properties:
+            bletch: 'xyzzy'
+        """)
+
+
+   The ``&node-x`` are YAML
+   `anchors <http://pyyaml.org/wiki/PyYAMLDocumentation#Aliases>`_ and
+   ``*node-x`` are YAML
+   `aliases <http://pyyaml.org/wiki/PyYAMLDocumentation#Aliases>`_.
+
+   See the ``tests/samples`` directory for other data examples.

setup.py

@@ -39,10 +39,11 @@
         'License :: OSI Approved :: MIT License',
         'Natural Language :: English',
         'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.6',
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: Implementation :: PyPy',
     ],
 )

tox.ini

@@ -1,17 +1,21 @@
 [tox]
-envlist = py27, py35, style, docs
+envlist = py27, py35, pypy, style, docs
 
 [testenv]
-basepython =
-    py27: /usr/local/bin/python2.7
-    py35: /usr/local/bin/python3.5
+basepython = /usr/local/bin/python3.5
 passenv = NEO4J_URI
 deps =
     -r{toxinidir}/requirements.txt
     pytest
 commands =
     py.test --basetemp={envtmpdir}
 
+[testenv:py27]
+basepython = /usr/local/bin/python2.7
+
+[testenv:pypy]
+basepython = /usr/local/bin/pypy
+
 [testenv:style]
 deps =
     -r{toxinidir}/requirements.txt