From 5827e0b77560a222ffc030fb7e5cda5fed3a35a1 Mon Sep 17 00:00:00 2001
From: davebshow <davebshow@gmail.com>
Date: Mon, 18 Jul 2016 19:50:14 -0400
Subject: [PATCH] added some docs, updated License to AGPL
---
LICENSE | 682 ++++++++++++++++++++++++++++++++++--
docs/Makefile | 225 ++++++++++++
docs/conf.py | 368 +++++++++++++++++++
docs/goblin.driver.rst | 29 ++
docs/goblin.rst | 78 +++++
docs/index.rst | 163 +++++++++
docs/modules.rst | 7 +
goblin/__init__.py | 17 +
goblin/abc.py | 26 +-
goblin/app.py | 68 +++-
goblin/driver/__init__.py | 17 +
goblin/driver/api.py | 40 ++-
goblin/driver/connection.py | 53 ++-
goblin/driver/graph.py | 37 +-
goblin/element.py | 65 +++-
goblin/exception.py | 18 +
goblin/mapper.py | 20 +-
goblin/properties.py | 36 +-
goblin/session.py | 188 ++++++++--
goblin/traversal.py | 46 ++-
setup.py | 4 +-
tests/conftest.py | 17 +
tests/test_app.py | 17 +
tests/test_driver.py | 17 +
tests/test_graph.py | 18 +
tests/test_mapper.py | 17 +
tests/test_properties.py | 17 +
tests/test_session.py | 17 +
28 files changed, 2204 insertions(+), 103 deletions(-)
create mode 100644 docs/Makefile
create mode 100644 docs/conf.py
create mode 100644 docs/goblin.driver.rst
create mode 100644 docs/goblin.rst
create mode 100644 docs/index.rst
create mode 100644 docs/modules.rst
diff --git a/LICENSE b/LICENSE
index d2c9f8f..9234142 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,21 +1,661 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 David Michael Brown
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+ Preamble
+
+The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+0. Definitions.
+
+"This License" refers to version 3 of the GNU Affero General Public License.
+
+"Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+1. Source Code.
+
+The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+The Corresponding Source for a work in source code form is that
+same work.
+
+2. Basic Permissions.
+
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+a) The work must carry prominent notices stating that you modified
+it, and giving a relevant date.
+
+b) The work must carry prominent notices stating that it is
+released under this License and any conditions added under section
+7. This requirement modifies the requirement in section 4 to
+"keep intact all notices".
+
+c) You must license the entire work, as a whole, under this
+License to anyone who comes into possession of a copy. This
+License will therefore apply, along with any applicable section 7
+additional terms, to the whole of the work, and all its parts,
+regardless of how they are packaged. This License gives no
+permission to license the work in any other way, but it does not
+invalidate such permission if you have separately received it.
+
+d) If the work has interactive user interfaces, each must display
+Appropriate Legal Notices; however, if the Program has interactive
+interfaces that do not display Appropriate Legal Notices, your
+work need not make them do so.
+
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+a) Convey the object code in, or embodied in, a physical product
+(including a physical distribution medium), accompanied by the
+Corresponding Source fixed on a durable physical medium
+customarily used for software interchange.
+
+b) Convey the object code in, or embodied in, a physical product
+(including a physical distribution medium), accompanied by a
+written offer, valid for at least three years and valid for as
+long as you offer spare parts or customer support for that product
+model, to give anyone who possesses the object code either (1) a
+copy of the Corresponding Source for all the software in the
+product that is covered by this License, on a durable physical
+medium customarily used for software interchange, for a price no
+more than your reasonable cost of physically performing this
+conveying of source, or (2) access to copy the
+Corresponding Source from a network server at no charge.
+
+c) Convey individual copies of the object code with a copy of the
+written offer to provide the Corresponding Source. This
+alternative is allowed only occasionally and noncommercially, and
+only if you received the object code with such an offer, in accord
+with subsection 6b.
+
+d) Convey the object code by offering access from a designated
+place (gratis or for a charge), and offer equivalent access to the
+Corresponding Source in the same way through the same place at no
+further charge. You need not require recipients to copy the
+Corresponding Source along with the object code. If the place to
+copy the object code is a network server, the Corresponding Source
+may be on a different server (operated by you or a third party)
+that supports equivalent copying facilities, provided you maintain
+clear directions next to the object code saying where to find the
+Corresponding Source. Regardless of what server hosts the
+Corresponding Source, you remain obligated to ensure that it is
+available for as long as needed to satisfy these requirements.
+
+e) Convey the object code using peer-to-peer transmission, provided
+you inform other peers where the object code and Corresponding
+Source of the work are being offered to the general public at no
+charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+7. Additional Terms.
+
+"Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+a) Disclaiming warranty or limiting liability differently from the
+terms of sections 15 and 16 of this License; or
+
+b) Requiring preservation of specified reasonable legal notices or
+author attributions in that material or in the Appropriate Legal
+Notices displayed by works containing it; or
+
+c) Prohibiting misrepresentation of the origin of that material, or
+requiring that modified versions of such material be marked in
+reasonable ways as different from the original version; or
+
+d) Limiting the use for publicity purposes of names of licensors or
+authors of the material; or
+
+e) Declining to grant rights under trademark law for use of some
+trade names, trademarks, or service marks; or
+
+f) Requiring indemnification of licensors and authors of that
+material by anyone who conveys the material (or modified versions of
+it) with contractual assumptions of liability to the recipient, for
+any liability that these contractual assumptions directly impose on
+those licensors and authors.
+
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+8. Termination.
+
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+12. No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+13. Remote Network Interaction; Use with the GNU General Public License.
+
+Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software. This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+<one line to give the program's name and a brief idea of what it does.>
+Copyright (C) <year> <name of author>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<http://www.gnu.org/licenses/>.
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..fbcb884
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,225 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " applehelp to make an Apple Help Book"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " epub3 to make an epub3"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+ @echo " coverage to run coverage check of the documentation (if enabled)"
+ @echo " dummy to check syntax errors of document sources"
+
+.PHONY: clean
+clean:
+ rm -rf $(BUILDDIR)/*
+
+.PHONY: html
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: pickle
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+.PHONY: json
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+.PHONY: htmlhelp
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+.PHONY: qthelp
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/goblin.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/goblin.qhc"
+
+.PHONY: applehelp
+applehelp:
+ $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+ @echo
+ @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+ @echo "N.B. You won't be able to view it unless you put it in" \
+ "~/Library/Documentation/Help or install it in your application" \
+ "bundle."
+
+.PHONY: devhelp
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/goblin"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/goblin"
+ @echo "# devhelp"
+
+.PHONY: epub
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: epub3
+epub3:
+ $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
+ @echo
+ @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
+
+.PHONY: latex
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+.PHONY: latexpdf
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: latexpdfja
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: text
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+.PHONY: man
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+.PHONY: texinfo
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+.PHONY: info
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+.PHONY: gettext
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+.PHONY: changes
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+.PHONY: linkcheck
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+.PHONY: doctest
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+ $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+ @echo "Testing of coverage in the sources finished, look at the " \
+ "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+.PHONY: dummy
+dummy:
+ $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
+ @echo
+ @echo "Build finished. Dummy builder generates no files."
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..04c6cd7
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,368 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# goblin documentation build configuration file, created by
+# sphinx-quickstart on Sat Jul 16 14:01:32 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+
+import alabaster
+import sys
+import os
+import shlex
+
+
+sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.viewcode',
+ 'alabaster'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'goblin'
+copyright = '2016, David M. Brown'
+author = 'David M. Brown'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#
+# today = ''
+#
+# Else, today_fmt is used as the format for a strftime call.
+#
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {
+ # 'logo': 'logo.png',
+ 'description': 'Async Python toolkit for the TP3 Gremlin Server',
+ 'logo_text_align': 'left',
+ 'github_user': 'davebshow',
+ 'github_repo': 'goblin',
+ 'github_button': True,
+ 'github_banner': True,
+ 'travis_button': True
+}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = [alabaster.get_path()]
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> documentation" by default.
+#
+# html_title = 'goblin v0.1.1'
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#
+# html_logo = None
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#
+# html_extra_path = []
+
+# If not None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+#
+# html_last_updated_fmt = None
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#
+html_sidebars = {
+ '**': [
+ 'about.html', 'navigation.html', 'searchbox.html', 'donate.html',
+ ]
+}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+#
+# html_domain_indices = True
+
+# If false, no index is generated.
+#
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
+#
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'goblindoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'goblin.tex', 'goblin Documentation',
+ 'David M. Brown', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+#
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#
+# latex_appendices = []
+
+# It false, will not define \strong, \code, itleref, \crossref ... but only
+# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
+# packages.
+#
+# latex_keep_old_macro_names = True
+
+# If false, no module index is generated.
+#
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'goblin', 'goblin Documentation',
+ [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'goblin', 'goblin Documentation',
+ author, 'goblin', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+#
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#
+# texinfo_no_detailmenu = False
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+ 'https://docs.python.org/3/': None,
+ 'aiohttp': ('http://aiohttp.readthedocs.org/en/stable/', None)}
diff --git a/docs/goblin.driver.rst b/docs/goblin.driver.rst
new file mode 100644
index 0000000..9f34e04
--- /dev/null
+++ b/docs/goblin.driver.rst
@@ -0,0 +1,29 @@
+goblin.driver package
+=====================
+
+Submodules
+----------
+
+goblin.driver.api module
+------------------------
+
+.. automodule:: goblin.driver.api
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+goblin.driver.connection module
+-------------------------------
+
+.. automodule:: goblin.driver.connection
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+goblin.driver.graph module
+--------------------------
+
+.. automodule:: goblin.driver.graph
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/goblin.rst b/docs/goblin.rst
new file mode 100644
index 0000000..ce13537
--- /dev/null
+++ b/docs/goblin.rst
@@ -0,0 +1,78 @@
+goblin package
+==============
+
+Subpackages
+-----------
+
+.. toctree::
+
+ goblin.driver
+
+Submodules
+----------
+
+goblin.abc module
+-----------------
+
+.. automodule:: goblin.abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+goblin.app module
+-----------------
+
+.. automodule:: goblin.app
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+goblin.element module
+---------------------
+
+.. automodule:: goblin.element
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+goblin.exception module
+-----------------------
+
+.. automodule:: goblin.exception
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+
+goblin.mapper module
+--------------------
+
+.. automodule:: goblin.mapper
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+goblin.properties module
+------------------------
+
+.. automodule:: goblin.properties
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+goblin.session module
+---------------------
+
+.. automodule:: goblin.session
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+goblin.traversal module
+-----------------------
+
+.. automodule:: goblin.traversal
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..fa7b74f
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,163 @@
+.. goblin documentation master file, created by
+ sphinx-quickstart on Sat Jul 16 14:01:32 2016.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Goblin - Async Python toolkit for the TinkerPop 3 Gremlin Server
+================================================================
+
+:py:mod:`Goblin` is an asynchronous Python toolkit for the `TinkerPop 3`_
+`Gremlin Server`_. In order to leverage Python's support for asynchronous
+programming paradigms, :py:mod:`Goblin<goblin>` is implemented using the async/await
+syntax introduced in Python 3.5, and does not support earlier Python versions.
+
+**Main features**:
+
+- Integration with the *official gremlin-python Gremlin Language Variant* (GLV)
+
+- Native Python support for asynchronous programing including *coroutines*,
+ *iterators*, and *context managers* as specified in `PEP 492`_
+
+- *Asynchronous Python driver* for the `Gremlin Server`_
+
+- :py:class:`AsyncRemoteGraph<goblin.driver.graph.AsyncRemoteGraph>`
+ implementation that produces *native Python GLV traversals*
+
+- High level asynchronous *Object Graph Mapper* (OGM)
+
+The Basics
+----------
+
+**Driver**
+
+Submit scripts and bindings to the `Gremlin Server`_::
+
+ >>> import asyncio
+ >>> from goblin import driver
+
+
+ >>> loop = asyncio.get_event_loop()
+
+
+ >>> async def go(loop):
+ ... script = "g.addV('developer').property(k1, v1)"
+ ... bindings = {'k1': 'name', 'v1': 'Leif'}
+ ... conn = await driver.GremlinServer.open('ws://localhost:8182/', loop)
+ ... async with conn:
+ ... resp = await conn.submit(script, bindings=bindings)
+ ... async for msg in resp:
+ ... print(msg)
+
+
+ >>> loop.run_until_complete(go(loop))
+ # {'type': 'vertex', 'id': 0, 'label': 'developer', 'properties': {'name': [{'id': 1, 'value': 'Leif'}]}}
+
+
+**AsyncRemoteGraph**
+
+Generate and submit Gremlin traversals in native Python::
+
+ >>> from goblin.gremlin_python import process # This will change when released
+
+
+ >>> connection = loop.run_until_complete(
+ ... driver.GremlinServer.open("http://localhost:8182/", loop))
+ >>> translator = process.GroovyTranslator('g')
+ >>> graph = driver.AsyncRemoteGraph(translator, connection)
+
+ >>> async def go(graph):
+ ... g = graph.traversal()
+ ... resp = await g.addV('developer').property('name', 'Leif').next()
+ ... async for msg in resp:
+ ... print(msg)
+ ... await graph.close()
+
+ >>> loop.run_until_complete(go(graph))
+ # {'properties': {'name': [{'value': 'Leif', 'id': 3}]}, 'label': 'developer', 'id': 2, 'type': 'vertex'}
+
+
+**OGM**
+
+Define custom vertex/edge classes using the provided base :py:mod:`classes<goblin.element>`,
+:py:class:`properties<goblin.properties.Property>`, and
+:py:mod:`data types<goblin.properties>`::
+
+ >>> from goblin import element, properties
+
+
+ >>> class Person(element.Vertex):
+ ... name = properties.Property(properties.String)
+ ... age = properties.Property(properties.Integer)
+
+
+ >>> class Knows(element.Edge):
+ ... notes = properties.Property(properties.String, default='N/A')
+
+
+Create a :py:class:`Goblin App<goblin.app.Goblin>` and register the element classes::
+
+ >>> from goblin import create_app
+
+
+ >>> app = loop.run_until_complete(
+ ... create_app('ws://localhost:8182/', loop))
+ >>> app.register(Person, Knows)
+
+
+Other than user defined properties, elements provide no interface. Use a
+:py:class:`Session<goblin.session.Session>` object to interact with the
+database::
+
+ >>> async def go(app):
+ ... session = await app.session()
+ ... async with session:
+ ... leif = Person()
+ ... leif.name = 'Leif'
+ ... leif.age = 28
+ ... jon = Person()
+ ... jon.name = 'Jonathan'
+ ... works_with = Knows(leif, jon)
+ ... session.add(leif, jon, works_with)
+ ... await session.flush()
+ ... result = await session.g.E(works_with.id).one_or_none()
+ ... assert result is works_with
+ ... people = await session.traversal(Person).all() # element class based traversal source
+ ... async for person in people:
+ ... print(person)
+
+
+ >>> loop.run_until_complete(go(app))
+ # <__main__.Person object at 0x7fba0b7fa6a0>
+ # <__main__.Person object at 0x7fba0b7fae48>
+
+Note that a :py:mod:`Goblin` session does not necessarily correspond to a Gremlin Server session.
+Instead, all elements created using a session are 'live' in the sense that if the
+results of a traversal executed against the session result in different property values
+for an element, that element will be updated to reflect these changes.
+
+Support for **vertex properties**, **sessions**, and **transactions** will be available
+in the next release...more docs coming soon.
+
+
+Contents:
+
+.. toctree::
+ :maxdepth: 4
+
+ modules
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. _Tinkerpop 3: http://tinkerpop.incubator.apache.org/
+.. _Gremlin Server: http://tinkerpop.apache.org/docs/3.1.1-incubating/reference/#gremlin-server
+.. _`Asyncio`: https://docs.python.org/3/library/asyncio.html
+.. _`aiohttp`: http://aiohttp.readthedocs.org/en/stable/
+.. _Github: https://github.com/davebshow/goblin/issues
+.. _PEP 492: https://www.python.org/dev/peps/pep-0492/
diff --git a/docs/modules.rst b/docs/modules.rst
new file mode 100644
index 0000000..7eee4a9
--- /dev/null
+++ b/docs/modules.rst
@@ -0,0 +1,7 @@
+Goblin API
+==========
+
+.. toctree::
+ :maxdepth: 4
+
+ goblin
diff --git a/goblin/__init__.py b/goblin/__init__.py
index c667870..354f37e 100644
--- a/goblin/__init__.py
+++ b/goblin/__init__.py
@@ -1,3 +1,20 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
from goblin.element import Vertex, Edge, VertexProperty
from goblin.app import create_app, Goblin
from goblin.properties import Property, String
diff --git a/goblin/abc.py b/goblin/abc.py
index f1b08eb..8fbe186 100644
--- a/goblin/abc.py
+++ b/goblin/abc.py
@@ -1,23 +1,47 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
import abc
class DataType(abc.ABC):
+ """
+ Abstract base class for Goblin Data Types. All custom data types should
+ inherit from :py:class:`DataType`.
+ """
@abc.abstractmethod
def validate(self):
+ """Validate property value"""
raise NotImplementedError
@abc.abstractmethod
def to_db(self, val):
+ """Convert property value to db compatible format"""
return val
@abc.abstractmethod
def to_ogm(self, val):
+ """Convert property value to a Python compatible format"""
return val
class BaseProperty:
-
+ """Abstract base class that implements the property interface"""
@property
def data_type(self):
raise NotImplementedError
diff --git a/goblin/app.py b/goblin/app.py
index 06e2c47..5740449 100644
--- a/goblin/app.py
+++ b/goblin/app.py
@@ -1,4 +1,22 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
"""Goblin application class and class constructor"""
+
import collections
import logging
@@ -10,8 +28,17 @@ logger = logging.getLogger(__name__)
async def create_app(url, loop, **config):
- """Constructor function for :py:class:`Engine`. Connects to database
- and builds a dictionary of relevant vendor implmentation features"""
+ """
+ Constructor function for :py:class:`Goblin`. Connect to database and
+ build a dictionary of relevant vendor implmentation features.
+
+ :param str url: Database url
+ :param asyncio.BaseEventLoop loop: Event loop implementation
+ :param dict config: Config parameters for application
+
+ :returns: :py:class:`Goblin` object
+ """
+
features = {}
async with await driver.GremlinServer.open(url, loop) as conn:
# Propbably just use a parser to parse the whole feature list
@@ -40,9 +67,17 @@ async def create_app(url, loop, **config):
# Main API classes
class Goblin:
- """Class used to encapsulate database connection configuration and generate
- database connections. Used as a factory to create :py:class:`Session`
- objects. More config coming soon."""
+ """
+ Class used to encapsulate database connection configuration and generate
+ database connections Used as a factory to create
+ :py:class:`Session<goblin.session.Session>` objects.
+
+ :param str url: Database url
+ :param asyncio.BaseEventLoop loop: Event loop implementation
+ :param dict features: Vendor implementation specific database features
+ :param dict config: Config parameters for application
+ """
+
DEFAULT_CONFIG = {
'translator': process.GroovyTranslator('g')
}
@@ -59,31 +94,43 @@ class Goblin:
@property
def vertices(self):
+ """Registered vertex classes"""
return self._vertices
@property
def edges(self):
+ """Registered edge classes"""
return self._edges
@property
def features(self):
+ """Vendor specific database implementation features"""
return self._features
def from_file(filepath):
- pass
+ """Load config from filepath. Not implemented"""
+ raise NotImplementedError
def from_obj(obj):
- pass
+ """Load config from object. Not implemented"""
+ raise NotImplementedError
@property
def translator(self):
+ """gremlin-python translator class"""
return self._config['translator']
@property
def url(self):
+ """Database url"""
return self._url
def register(self, *elements):
+ """
+ Register user created Element classes.
+
+ :param goblin.element.Element elements: User defined Element classes
+ """
for element in elements:
if element.__type__ == 'vertex':
self._vertices[element.__label__] = element
@@ -91,6 +138,13 @@ class Goblin:
self._edges[element.__label__] = element
async def session(self, *, use_session=False):
+ """
+ Create a session object.
+
+ :param bool use_session: Create a database session. Not implemented
+
+ :returns: :py:class:`Session<goblin.session.Session>` object
+ """
conn = await driver.GremlinServer.open(self.url, self._loop)
return session.Session(self,
conn,
diff --git a/goblin/driver/__init__.py b/goblin/driver/__init__.py
index 26f2940..0e790b6 100644
--- a/goblin/driver/__init__.py
+++ b/goblin/driver/__init__.py
@@ -1,3 +1,20 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
from goblin.driver.api import GremlinServer
from goblin.driver.connection import AbstractConnection
from goblin.driver.graph import AsyncRemoteGraph
diff --git a/goblin/driver/api.py b/goblin/driver/api.py
index 0898193..717af37 100644
--- a/goblin/driver/api.py
+++ b/goblin/driver/api.py
@@ -1,3 +1,20 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
import asyncio
import aiohttp
@@ -5,15 +22,28 @@ from goblin.driver import connection
class GremlinServer:
+ """Factory class that generates connections to the Gremlin Server"""
@classmethod
async def open(cls,
- url: str,
- loop: asyncio.BaseEventLoop,
+ url,
+ loop,
*,
- client_session: aiohttp.ClientSession=None,
- username: str=None,
- password: str=None) -> connection.Connection:
+ client_session=None,
+ username=None,
+ password=None):
+ """
+ Open a connection to the Gremlin Server.
+
+ :param str url: Database url
+ :param asyncio.BaseEventLoop loop: Event loop implementation
+ :param aiohttp.client.ClientSession client_session: Client session
+ used to generate websocket connections.
+ :param str username: Username for server auth
+ :param str password: Password for server auth
+
+ :returns: :py:class:`Connection<goblin.driver.connection.Connection>`
+ """
if client_session is None:
client_session = aiohttp.ClientSession(loop=loop)
ws = await client_session.ws_connect(url)
diff --git a/goblin/driver/connection.py b/goblin/driver/connection.py
index 4f6d7e1..7c783d6 100644
--- a/goblin/driver/connection.py
+++ b/goblin/driver/connection.py
@@ -1,3 +1,20 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
import abc
import asyncio
import collections
@@ -33,7 +50,7 @@ def error_handler(fn):
class Response:
-
+ """Gremlin Server response implementated as an async iterator."""
def __init__(self, response_queue, loop):
self._response_queue = response_queue
self._loop = loop
@@ -51,6 +68,7 @@ class Response:
@error_handler
async def fetch_data(self):
+ """Get a single message from the response stream"""
if self._done:
return None
msg = await self._response_queue.get()
@@ -60,7 +78,7 @@ class Response:
class AbstractConnection(abc.ABC):
-
+ """Defines the interface for a connection object."""
@abc.abstractmethod
async def submit(self):
raise NotImplementedError
@@ -71,7 +89,11 @@ class AbstractConnection(abc.ABC):
class Connection(AbstractConnection):
-
+ """
+ Main classd for interacting with the Gremlin Server. Encapsulates a
+ websocket connection. Not instantiated directly. Instead use
+ :py:meth:`GremlinServer.open<goblin.driver.api.GremlinServer.open>`.
+ """
def __init__(self, url, ws, loop, conn_factory, *, username=None,
password=None):
self._url = url
@@ -105,6 +127,22 @@ class Connection(AbstractConnection):
processor="",
session=None,
request_id=None):
+ """
+ Submit a script and bindings to the Gremlin Server
+
+ :param str gremlin: Gremlin script to submit to server.
+ :param dict bindings: A mapping of bindings for Gremlin script.
+ :param str lang: Language of scripts submitted to the server.
+ "gremlin-groovy" by default
+ :param dict aliases: Rebind ``Graph`` and ``TraversalSource``
+ objects to different variable names in the current request
+ :param str op: Gremlin Server op argument. "eval" by default.
+ :param str processor: Gremlin Server processor argument. "" by default.
+ :param str session: Session id (optional). Typically a uuid
+ :param str request_id: Request id (optional). Typically a uuid
+
+ :returns: :py:class:`Response` object
+ """
if aliases is None:
aliases = {}
if request_id is None:
@@ -122,10 +160,11 @@ class Connection(AbstractConnection):
if self._ws.closed:
self._ws = await self.conn_factory.ws_connect(self.url)
self._ws.send_bytes(message)
- self._loop.create_task(self.receive())
+ self._loop.create_task(self._receive())
return Response(response_queue, self._loop)
async def close(self):
+ """Close underlying connection and mark as closed."""
await self._ws.close()
self._closed = True
await self._conn_factory.close()
@@ -178,7 +217,7 @@ class Connection(AbstractConnection):
raise ValueError("Unknown mime type.")
return b"".join([mime_len, mime_type, message.encode("utf-8")])
- async def receive(self):
+ async def _receive(self):
data = await self._ws.receive()
if data.tp == aiohttp.MsgType.close:
await self._ws.close()
@@ -200,7 +239,7 @@ class Connection(AbstractConnection):
if status_code == 407:
await self._authenticate(self._username, self._password,
self._processor, self._session)
- self._loop.create_task(self.receive())
+ self._loop.create_task(self._receive())
else:
if data:
for result in data:
@@ -210,7 +249,7 @@ class Connection(AbstractConnection):
message = Message(status_code, data, msg)
response_queue.put_nowait(message)
if status_code == 206:
- self._loop.create_task(self.receive())
+ self._loop.create_task(self._receive())
else:
response_queue.put_nowait(None)
del self._response_queues[request_id]
diff --git a/goblin/driver/graph.py b/goblin/driver/graph.py
index 09d0973..7c41168 100644
--- a/goblin/driver/graph.py
+++ b/goblin/driver/graph.py
@@ -1,5 +1,26 @@
-from goblin.gremlin_python.process.graph_traversal import GraphTraversalSource, GraphTraversal
-from goblin.gremlin_python.process.traversal import TraversalStrategy, TraversalStrategies
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
+"""A temporary solution to allow integration with gremlin_python package."""
+
+from goblin.gremlin_python.process.graph_traversal import (
+ GraphTraversalSource, GraphTraversal)
+from goblin.gremlin_python.process.traversal import (
+ TraversalStrategy, TraversalStrategies)
class AsyncGraphTraversal(GraphTraversal):
@@ -36,6 +57,17 @@ class AsyncGraph:
class AsyncRemoteGraph(AsyncGraph):
+ """
+ Generate asynchronous gremlin traversals using native Python.
+
+ :param gremlin_python.process.GroovyTranslator translator:
+ gremlin_python translator class, typically
+ :py:class:`GroovyTranslator<gremlin_python.process.GroovyTranslator>`
+ :param goblin.driver.connection connection: underlying remote
+ connection
+ :param gremlin_python.process.GraphTraversal graph_traversal:
+ Custom graph traversal class
+ """
def __init__(self, translator, remote_connection, *, graph_traversal=None):
self.traversal_strategy = AsyncRemoteStrategy() # A single traversal strategy
self.translator = translator
@@ -48,6 +80,7 @@ class AsyncRemoteGraph(AsyncGraph):
return "remotegraph[" + self.remote_connection.url + "]"
async def close(self):
+ """Close underlying remote connection"""
await self.remote_connection.close()
self.remote_connection = None
diff --git a/goblin/element.py b/goblin/element.py
index b7597d3..cd39b45 100644
--- a/goblin/element.py
+++ b/goblin/element.py
@@ -1,3 +1,20 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
import logging
import inflection
@@ -11,10 +28,11 @@ logger = logging.getLogger(__name__)
class ElementMeta(type):
- """Metaclass for graph elements. Responsible for creating the
- the :py:class:`mapper.Mapping` object and replacing user defined
- :py:class:`property.Property` with
- :py:class:`property.PropertyDescriptor`"""
+ """
+ Metaclass for graph elements. Responsible for creating the
+ :py:class:`Mapping<mapper.Mapping>` object and replacing user defined
+ :py:class:`property.Property` with :py:class:`property.PropertyDescriptor`.
+ """
def __new__(cls, name, bases, namespace, **kwds):
if bases:
namespace['__type__'] = bases[0].__name__.lower()
@@ -29,15 +47,12 @@ class ElementMeta(type):
new_namespace[k] = v
new_namespace['__mapping__'] = mapper.create_mapping(namespace,
props)
- if name not in ('Element', 'Vertex', 'Edge', 'VertexProperty'
- 'GenericVertex', 'GenericEdge'):
- logger.warning("Creating new Element class {}: {}".format(
- name, new_namespace['__mapping__']))
result = type.__new__(cls, name, bases, new_namespace)
return result
class Element(metaclass=ElementMeta):
+ """Base class for classes that implement the Element property interface"""
pass
@@ -47,12 +62,20 @@ class Vertex(Element):
class GenericVertex(Vertex):
+ """
+ Class used to build vertices when user defined vertex class is not
+ available. Generally not instantiated by end user.
+ """
pass
class Edge(Element):
- """Base class for user defined Edge classes"""
+ """
+ Base class for user defined Edge classes.
+ :param Vertex source: Source (outV) vertex
+ :param Vertex target: Target (inV) vertex
+ """
def __init__(self, source=None, target=None):
self._source = source
self._target = target
@@ -60,9 +83,9 @@ class Edge(Element):
def getsource(self):
return self._source
- def setsource(self, val):
- assert isinstance(val, Vertex) or val is None
- self._source = val
+ def setsource(self, vertex):
+ assert isinstance(vertex, Vertex) or vertex is None
+ self._source = vertex
def delsource(self):
del self._source
@@ -72,9 +95,9 @@ class Edge(Element):
def gettarget(self):
return self._target
- def settarget(self, val):
- assert isinstance(val, Vertex) or val is None
- self._target = val
+ def settarget(self, vertex):
+ assert isinstance(vertex, Vertex) or vertex is None
+ self._target = vertex
def deltarget(self):
del self._target
@@ -83,12 +106,17 @@ class Edge(Element):
class GenericEdge(Edge):
- pass
+ """
+ Class used to build edges when user defined edges class is not available.
+ Generally not instantiated by end user.
+ """
class VertexPropertyDescriptor:
- """Descriptor that validates user property input and gets/sets properties
- as instance attributes."""
+ """
+ Descriptor that validates user property input and gets/sets properties
+ as instance attributes.
+ """
def __init__(self, name, vertex_property):
self._name = '_' + name
@@ -120,6 +148,7 @@ class VertexPropertyDescriptor:
class VertexProperty(Element, abc.BaseProperty):
+ """Base class for user defined vertex properties. Not yet supported."""
__descriptor__ = VertexPropertyDescriptor
diff --git a/goblin/exception.py b/goblin/exception.py
index ecce2cc..5d58ac7 100644
--- a/goblin/exception.py
+++ b/goblin/exception.py
@@ -1,3 +1,21 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
+
class MappingError(Exception):
pass
diff --git a/goblin/mapper.py b/goblin/mapper.py
index 8ff92b9..baef932 100644
--- a/goblin/mapper.py
+++ b/goblin/mapper.py
@@ -1,4 +1,22 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
"""Helper functions and class to map between OGM Elements <-> DB Elements"""
+
import logging
import functools
@@ -116,6 +134,6 @@ class Mapping:
self._properties[name] = (db_name, data_type)
def __repr__(self):
- return '<{}(type={}, label={}, properties={})'.format(
+ return '<{}(type={}, label={}, properties={})>'.format(
self.__class__.__name__, self._element_type, self._label,
self._properties)
diff --git a/goblin/properties.py b/goblin/properties.py
index a49d9ca..5906312 100644
--- a/goblin/properties.py
+++ b/goblin/properties.py
@@ -1,4 +1,22 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
"""Classes to handle proerties and data type definitions"""
+
import logging
from goblin import abc, exception
@@ -7,8 +25,10 @@ logger = logging.getLogger(__name__)
class PropertyDescriptor:
- """Descriptor that validates user property input and gets/sets properties
- as instance attributes."""
+ """
+ Descriptor that validates user property input and gets/sets properties
+ as instance attributes. Not instantiated by user.
+ """
def __init__(self, name, prop):
self._prop_name = name
@@ -32,8 +52,13 @@ class PropertyDescriptor:
class Property(abc.BaseProperty):
- """API class used to define properties. Replaced with
- :py:class:`PropertyDescriptor` by :py:class:`api.ElementMeta`."""
+ """
+ API class used to define properties. Replaced with
+ :py:class:`PropertyDescriptor` by :py:class:`goblin.element.ElementMeta`.
+
+ :param goblin.abc.DataType data_type: Str or class of data type
+ :param default: Default value for this property.
+ """
__descriptor__ = PropertyDescriptor
@@ -72,10 +97,9 @@ class String(abc.DataType):
class Integer(abc.DataType):
- """Simple string datatype"""
+ """Simple integer datatype"""
def validate(self, val):
- """Need to think about this."""
if val is not None:
try:
return int(val)
diff --git a/goblin/session.py b/goblin/session.py
index 3643a9e..e6586f2 100644
--- a/goblin/session.py
+++ b/goblin/session.py
@@ -1,4 +1,22 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
"""Main OGM API classes and constructors"""
+
import asyncio
import collections
import logging
@@ -13,8 +31,15 @@ logger = logging.getLogger(__name__)
class Session(connection.AbstractConnection):
- """Provides the main API for interacting with the database. Does not
- necessarily correpsond to a database session."""
+ """
+ Provides the main API for interacting with the database. Does not
+ necessarily correpsond to a database session. Don't instantiate directly,
+ instead use :py:meth:`Goblin.session<goblin.app.Goblin.session>`.
+
+ :param goblin.app.Goblin app:
+ :param goblin.driver.connection conn:
+ :param bool use_session: Support for Gremlin Server session. Not implemented
+ """
def __init__(self, app, conn, *, use_session=False):
self._app = app
@@ -51,17 +76,35 @@ class Session(connection.AbstractConnection):
await self.close()
async def close(self):
+ """
+ Close the underlying db connection and disconnect session from Goblin
+ application.
+ """
await self.conn.close()
self._app = None
# Traversal API
@property
def g(self):
- """Returns a simple traversal source"""
+ """
+ Get a simple traversal source.
+
+ :returns:
+ :py:class:`goblin.gremlin_python.process.GraphTraversalSource`
+ object
+ """
return self.traversal_factory.traversal()
def traversal(self, element_class):
- """Returns a traversal spawned from an element class"""
+ """
+ Get a traversal spawned from an element class.
+
+ :param :goblin.element.Element element_class: Element class
+ used to spawn traversal.
+
+ :returns: :py:class:`GoblinTraversal<goblin.traversal.GoblinTraversal>`
+ object
+ """
return self.traversal_factory.traversal(element_class=element_class)
async def submit(self,
@@ -69,7 +112,18 @@ class Session(connection.AbstractConnection):
*,
bindings=None,
lang='gremlin-groovy'):
- """Get all results generated by query"""
+ """
+ Submit a query to the Gremiln Server.
+
+ :param str gremlin: Gremlin script to submit to server.
+ :param dict bindings: A mapping of bindings for Gremlin script.
+ :param str lang: Language of scripts submitted to the server.
+ "gremlin-groovy" by default
+
+ :returns:
+ :py:class:`TraversalResponse<goblin.traversal.TraversalResponse>`
+ object
+ """
await self.flush()
async_iter = await self.conn.submit(
gremlin, bindings=bindings, lang=lang)
@@ -96,29 +150,55 @@ class Session(connection.AbstractConnection):
# Creation API
def add(self, *elements):
+ """
+ Add elements to session pending queue.
+
+ :param goblin.element.Element elements: Elements to be added
+ """
for elem in elements:
self._pending.append(elem)
async def flush(self):
+ """
+ Issue creation/update queries to database for all elements in the
+ session pending queue.
+ """
while self._pending:
elem = self._pending.popleft()
await self.save(elem)
- async def remove_vertex(self, element):
- traversal = self.traversal_factory.remove_vertex(element)
- result = await self._simple_traversal(traversal, element)
- element = self.current.pop(element.id)
- del element
+ async def remove_vertex(self, vertex):
+ """
+ Remove a vertex from the db.
+
+ :param goblin.element.Vertex vertex: Vertex to be removed
+ """
+ traversal = self.traversal_factory.remove_vertex(vertex)
+ result = await self._simple_traversal(traversal, vertex)
+ vertex = self.current.pop(vertex.id)
+ del vertex
return result
- async def remove_edge(self, element):
- traversal = self.traversal_factory.remove_edge(element)
- result = await self._simple_traversal(traversal, element)
- element = self.current.pop(element.id)
- del element
+ async def remove_edge(self, edge):
+ """
+ Remove an edge from the db.
+
+ :param goblin.element.Edge edge: Element to be removed
+ """
+ traversal = self.traversal_factory.remove_edge(edge)
+ result = await self._simple_traversal(traversal, edge)
+ edge = self.current.pop(edge.id)
+ del edge
return result
async def save(self, element):
+ """
+ Save an element to the db.
+
+ :param goblin.element.Element element: Vertex or Edge to be saved
+
+ :returns: :py:class:`Element<goblin.element.Element>` object
+ """
if element.__type__ == 'vertex':
result = await self.save_vertex(element)
elif element.__type__ == 'edge':
@@ -128,51 +208,95 @@ class Session(connection.AbstractConnection):
"Unknown element type: {}".format(element.__type__))
return result
- async def save_vertex(self, element):
+ async def save_vertex(self, vertex):
+ """
+ Save a vertex to the db.
+
+ :param goblin.element.Vertex element: Vertex to be saved
+
+ :returns: :py:class`Vertex<goblin.element.Vertex>` object
+ """
result = await self._save_element(
- element, self._check_vertex,
+ vertex, self._check_vertex,
self.traversal_factory.add_vertex,
self.update_vertex)
self.current[result.id] = result
return result
- async def save_edge(self, element):
- if not (hasattr(element, 'source') and hasattr(element, 'target')):
+ async def save_edge(self, edge):
+ """
+ Save an edge to the db.
+
+ :param goblin.element.Edge element: Edge to be saved
+
+ :returns: :py:class:`Edge<goblin.element.Edge>` object
+ """
+ if not (hasattr(edge, 'source') and hasattr(edge, 'target')):
raise exception.ElementError(
"Edges require both source/target vertices")
result = await self._save_element(
- element, self._check_edge,
+ edge, self._check_edge,
self.traversal_factory.add_edge,
self.update_edge)
self.current[result.id] = result
return result
- async def get_vertex(self, element):
+ async def get_vertex(self, vertex):
+ """
+ Get a vertex from the db. Vertex must have id.
+
+ :param goblin.element.Vertex element: Vertex to be retrieved
+
+ :returns: :py:class:`Vertex<goblin.element.Vertex>` | None
+ """
return await self.traversal_factory.get_vertex_by_id(
- element).one_or_none()
+ vertex).one_or_none()
+
+ async def get_edge(self, edge):
+ """
+ Get a edge from the db. Edge must have id.
+
+ :param goblin.element.Edge element: Edge to be retrieved
- async def get_edge(self, element):
+ :returns: :py:class:`Edge<goblin.element.Edge>` | None
+ """
return await self.traversal_factory.get_edge_by_id(
- element).one_or_none()
+ edge).one_or_none()
- async def update_vertex(self, element):
- props = mapper.map_props_to_db(element, element.__mapping__)
- traversal = self.g.V(element.id)
- return await self._update_properties(element, traversal, props)
+ async def update_vertex(self, vertex):
+ """
+ Update a vertex, generally to change/remove property values.
- async def update_edge(self, element):
- props = mapper.map_props_to_db(element, element.__mapping__)
- traversal = self.g.E(element.id)
- return await self._update_properties(element, traversal, props)
+ :param goblin.element.Vertex vertex: Vertex to be updated
+
+ :returns: :py:class:`Vertex<goblin.element.Vertex>` object
+ """
+ props = mapper.map_props_to_db(vertex, vertex.__mapping__)
+ traversal = self.g.V(vertex.id)
+ return await self._update_properties(vertex, traversal, props)
+
+ async def update_edge(self, edge):
+ """
+ Update an edge, generally to change/remove property values.
+
+ :param goblin.element.Edge edge: Edge to be updated
+
+ :returns: :py:class:`Edge<goblin.element.Edge>` object
+ """
+ props = mapper.map_props_to_db(edge, edge.__mapping__)
+ traversal = self.g.E(edge.id)
+ return await self._update_properties(edge, traversal, props)
# Transaction support
def tx(self):
+ """Not implemented"""
raise NotImplementedError
def _wrap_in_tx(self):
raise NotImplementedError
async def commit(self):
+ """Not implemented"""
await self.flush()
if self.engine._features['transactions'] and self._use_session():
await self.tx()
diff --git a/goblin/traversal.py b/goblin/traversal.py
index 8362c13..15ab964 100644
--- a/goblin/traversal.py
+++ b/goblin/traversal.py
@@ -1,4 +1,22 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
"""Query API and helpers"""
+
import asyncio
import functools
import logging
@@ -11,7 +29,7 @@ logger = logging.getLogger(__name__)
class TraversalResponse:
-
+ """Asynchronous iterator that encapsulates a traversal response queue"""
def __init__(self, response_queue):
self._queue = response_queue
self._done = False
@@ -34,9 +52,19 @@ class TraversalResponse:
class GoblinTraversal(graph.AsyncGraphTraversal):
async def all(self):
+ """
+ Get all results from traversal.
+
+ :returns: :py:class:`TraversalResponse` object
+ """
return await self.next()
async def one_or_none(self):
+ """
+ Get one or zero results from a traveral.
+
+ :returns: :py:class:`Element<goblin.element.Element>` object
+ """
result = None
async for msg in await self.next():
result = msg
@@ -53,6 +81,16 @@ class TraversalFactory:
return self._graph
def traversal(self, *, element_class=None):
+ """
+ Generate a traversal using a user defined element class as a
+ starting point.
+
+ :param goblin.element.Element element_class: An optional element
+ class that will dictate the element type (vertex/edge) as well as
+ the label for the traversal source
+
+ :returns: :py:class:`GoblinTraversal`
+ """
traversal = self.graph.traversal()
if element_class:
label = element_class.__mapping__.label
@@ -65,23 +103,29 @@ class TraversalFactory:
return traversal
def remove_vertex(self, element):
+ """Convenience function for generating crud traversals."""
return self.traversal().V(element.id).drop()
def remove_edge(self, element):
+ """Convenience function for generating crud traversals."""
return self.traversal().E(element.id).drop()
def get_vertex_by_id(self, element):
+ """Convenience function for generating crud traversals."""
return self.traversal().V(element.id)
def get_edge_by_id(self, element):
+ """Convenience function for generating crud traversals."""
return self.traversal().E(element.id)
def add_vertex(self, element):
+ """Convenience function for generating crud traversals."""
props = mapper.map_props_to_db(element, element.__mapping__)
traversal = self.traversal().addV(element.__mapping__.label)
return self._add_properties(traversal, props)
def add_edge(self, element):
+ """Convenience function for generating crud traversals."""
props = mapper.map_props_to_db(element, element.__mapping__)
traversal = self.traversal().V(element.source.id)
traversal = traversal.addE(element.__mapping__._label)
diff --git a/setup.py b/setup.py
index 186a911..654cd0a 100644
--- a/setup.py
+++ b/setup.py
@@ -5,10 +5,10 @@ setup(
name="goblin",
version="0.1.0",
url="",
- license="MIT",
+ license="AGPL",
author="davebshow",
author_email="davebshow@gmail.com",
- description="Python driver for TP3 Gremlin Server",
+ description="Python toolkit for TP3 Gremlin Server",
packages=["goblin", "goblin.gremlin_python", "goblin.gremlin_python.process",
"goblin.gremlin_python.driver", "goblin.gremlin_python.structure",
"goblin.driver", "tests"],
diff --git a/tests/conftest.py b/tests/conftest.py
index c4b6a41..5e77cdf 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -1,3 +1,20 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
import pytest
from goblin import create_app, driver, element, properties
from goblin.gremlin_python import process
diff --git a/tests/test_app.py b/tests/test_app.py
index 05ad04e..14223cf 100644
--- a/tests/test_app.py
+++ b/tests/test_app.py
@@ -1,3 +1,20 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
from goblin import element
from goblin.gremlin_python import process
diff --git a/tests/test_driver.py b/tests/test_driver.py
index 6c4391a..825022d 100644
--- a/tests/test_driver.py
+++ b/tests/test_driver.py
@@ -1,3 +1,20 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
import pytest
from goblin import exception
diff --git a/tests/test_graph.py b/tests/test_graph.py
index 0e7d0a2..81e7ac7 100644
--- a/tests/test_graph.py
+++ b/tests/test_graph.py
@@ -1,4 +1,22 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
import pytest
+
from goblin.gremlin_python import process
diff --git a/tests/test_mapper.py b/tests/test_mapper.py
index a8b8454..651ecd7 100644
--- a/tests/test_mapper.py
+++ b/tests/test_mapper.py
@@ -1,3 +1,20 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
import pytest
from goblin import exception, properties
diff --git a/tests/test_properties.py b/tests/test_properties.py
index 73b2d48..db44cdc 100644
--- a/tests/test_properties.py
+++ b/tests/test_properties.py
@@ -1,3 +1,20 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
import pytest
diff --git a/tests/test_session.py b/tests/test_session.py
index a340c6e..001548b 100644
--- a/tests/test_session.py
+++ b/tests/test_session.py
@@ -1,3 +1,20 @@
+# Copyright 2016 ZEROFAIL
+#
+# This file is part of Goblin.
+#
+# Goblin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Goblin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Goblin. If not, see <http://www.gnu.org/licenses/>.
+
import pytest
from goblin import element
--
GitLab