Metadata-Version: 1.1
Name: pypuppetdb
Version: 0.0.1
Summary: Library for working with the PuppetDB REST API.
Home-page: https://github.com/nedap/pypuppetdb
Author: Daniele Sluijters
Author-email: daniele.sluijters+pypi@gmail.com
License: Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and
distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright
owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities
that control, are controlled by, or are under common control with that entity.
For the purposes of this definition, "control" means (i) the power, direct or
indirect, to cause the direction or management of such entity, whether by
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising
permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including
but not limited to software source code, documentation source, and configuration
files.

"Object" form shall mean any form resulting from mechanical transformation or
translation of a Source form, including but not limited to compiled object code,
generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made
available under the License, as indicated by a copyright notice that is included
in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that
is based on (or derived from) the Work and for which the editorial revisions,
annotations, elaborations, or other modifications represent, as a whole, an
original work of authorship. For the purposes of this License, Derivative Works
shall not include works that remain separable from, or merely link (or bind by
name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version
of the Work and any modifications or additions to that Work or Derivative Works
thereof, that is intentionally submitted to Licensor for inclusion in the Work
by the copyright owner or by an individual or Legal Entity authorized to submit
on behalf of the copyright owner. For the purposes of this definition,
"submitted" means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems, and
issue tracking systems that are managed by, or on behalf of, the Licensor for
the purpose of discussing and improving the Work, but excluding communication
that is conspicuously marked or otherwise designated in writing by the copyright
owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
of whom a Contribution has been received by Licensor and subsequently
incorporated within the Work.

2. Grant of Copyright License.

Subject to the terms and conditions of this License, each Contributor hereby
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
irrevocable copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the Work and such
Derivative Works in Source or Object form.

3. Grant of Patent License.

Subject to the terms and conditions of this License, each Contributor hereby
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
irrevocable (except as stated in this section) patent license to make, have
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
such license applies only to those patent claims licensable by such Contributor
that are necessarily infringed by their Contribution(s) alone or by combination
of their Contribution(s) with the Work to which such Contribution(s) was
submitted. If You institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
Contribution incorporated within the Work constitutes direct or contributory
patent infringement, then any patent licenses granted to You under this License
for that Work shall terminate as of the date such litigation is filed.

4. Redistribution.

You may reproduce and distribute copies of the Work or Derivative Works thereof
in any medium, with or without modifications, and in Source or Object form,
provided that You meet the following conditions:

You must give any other recipients of the Work or Derivative Works a copy of
this License; and
You must cause any modified files to carry prominent notices stating that You
changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute,
all copyright, patent, trademark, and attribution notices from the Source form
of the Work, excluding those notices that do not pertain to any part of the
Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any
Derivative Works that You distribute must include a readable copy of the
attribution notices contained within such NOTICE file, excluding those notices
that do not pertain to any part of the Derivative Works, in at least one of the
following places: within a NOTICE text file distributed as part of the
Derivative Works; within the Source form or documentation, if provided along
with the Derivative Works; or, within a display generated by the Derivative
Works, if and wherever such third-party notices normally appear. The contents of
the NOTICE file are for informational purposes only and do not modify the
License. You may add Your own attribution notices within Derivative Works that
You distribute, alongside or as an addendum to the NOTICE text from the Work,
provided that such additional attribution notices cannot be construed as
modifying the License.
You may add Your own copyright statement to Your modifications and may provide
additional or different license terms and conditions for use, reproduction, or
distribution of Your modifications, or for any such Derivative Works as a whole,
provided Your use, reproduction, and distribution of the Work otherwise complies
with the conditions stated in this License.

5. Submission of Contributions.

Unless You explicitly state otherwise, any Contribution intentionally submitted
for inclusion in the Work by You to the Licensor shall be under the terms and
conditions of this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify the terms of
any separate license agreement you may have executed with Licensor regarding
such Contributions.

6. Trademarks.

This License does not grant permission to use the trade names, trademarks,
service marks, or product names of the Licensor, except as required for
reasonable and customary use in describing the origin of the Work and
reproducing the content of the NOTICE file.

7. Disclaimer of Warranty.

Unless required by applicable law or agreed to in writing, Licensor provides the
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
including, without limitation, any warranties or conditions of TITLE,
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
solely responsible for determining the appropriateness of using or
redistributing the Work and assume any risks associated with Your exercise of
permissions under this License.

8. Limitation of Liability.

In no event and under no legal theory, whether in tort (including negligence),
contract, or otherwise, unless required by applicable law (such as deliberate
and grossly negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special, incidental,
or consequential damages of any character arising as a result of this License or
out of the use or inability to use the Work (including but not limited to
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
any and all other commercial damages or losses), even if such Contributor has
been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability.

While redistributing the Work or Derivative Works thereof, You may choose to
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
other liability obligations and/or rights consistent with this License. However,
in accepting such obligations, You may act only on Your own behalf and on Your
sole responsibility, not on behalf of any other Contributor, and only if You
agree to indemnify, defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason of your
accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work

To apply the Apache License to your work, attach the following boilerplate
notice, with the fields enclosed by brackets "[]" replaced with your own
identifying information. (Don't include the brackets!) The text should be
enclosed in the appropriate comment syntax for the file format. We also
recommend that a file or class name and description of purpose be included on
the same "printed page" as the copyright notice for easier identification within
third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Description: ##########
        pypuppetdb
        ##########
        
        pypuppetdtb is a library to work with PuppetDB's REST API. It is implemented
        using the `requests`_ library.
        
        .. _requests: http://docs.python-requests.org/en/latest/
        
        This library is a thin wrapper around the REST API providing some convinience
        functions and objects to request and hold data from PuppetDB.
        
        To use this library you will need:
            * Python 2.6 or 2.7
            * Python 3.3
        
        Installation
        ============
        
        You can install this package from source or from PyPi.
        
        .. code-block:: bash
        
           $ pip install pypuppetdb
        
        .. code-block:: bash
        
           $ git clone https://github.com/nedap/pypuppetdb
           $ python setup.py install
        
        If you wish to hack on it clone the repository but after that run:
        
        .. code-block:: bash
        
           $ pip install -r requirements.txt
        
        This will install all the runtime requirements of pypuppetdb and the
        dependencies for the test suite and generation of documentation.
        
        Usage
        =====
        
        Once you have pypuppetdb installed you can configure it to connect to PuppetDB
        and take it from there.
        
        Connecting
        ----------
        
        The first thing you need to do is to connect with PuppetDB:
        
        .. code-block:: python
        
           >>> from pypuppetdb import connect
           >>> db = connect()
        
        Nodes
        -----
        
        The following will return a generator object yielding Node objects for every
        returned node from PuppetDB.
        
        .. code-block:: python
        
           >>> nodes = db.nodes()
           >>> for node in nodes:
           >>>   print(node)
           host1
           host2
           ...
        
        To query a single node the singular `node()` can be used:
        
        .. code-block:: python
        
            >>> node = db.node('hostname')
            >>> print(node)
            hostname
        
        Node scope
        ~~~~~~~~~~
        
        The Node objects are a bit more special in that they can query for facts and
        resources themselves. Using those methods from a node object will automatically
        add a query to the request scoping the request to the node.
        
        .. code-block:: python
        
           >>> node = db.node('hostname')
           >>> print(node.fact('osfamily'))
           osfamily/hostname
        
        Facts
        -----
        
        .. code-block:: python
        
           >>> facts = db.facts('osfamily')
           >>> for fact in facts:
           >>>   print(fact)
           osfamily/host1
           osfamily/host2
        
        That queries PuppetDB for the 'osfamily' fact and will yield Fact objects,
        one per node this fact is known for.
        
        Resources
        ---------
        
        .. code-block:: python
        
           >>> resources = db.resources('file')
        
        Will return a generator object containing all file resources you're managing
        across your infrastructure. This is probably a bad idea if you have a big
        number of nodes as the response will be huge.
        
        Getting Help
        ============
        This project is still very new so it's not inconceivable you'll run into
        issues.
        
        For bug reports you can file an `issue`_. If you need help with something
        feel free to hit up `@daenney`_ by e-mail or find him on IRC. He can usually
        be found on `IRCnet`_ and `Freenode`_ and idles in #puppet.
        
        .. _issue: https://github.com/nedap/pypuppetdb/issues
        .. _@daenney: https://github.com/daenney
        .. _IRCnet: http://www.ircnet.org
        .. _Freenode: http://freenode.net
        
        Documentation
        =============
        API documentation is automatically generated from the docstrings using
        Sphinx's autodoc feature. 
        
        Documentation will automatically be rebuilt on every push thanks to the
        Read The Docs webhook. You can `find it here`_.
        
        .. _find it here: https://pypuppetdb.readthedocs.org/en/latest/
        
        You can build the documentation manually by doing:
        
        .. code-block:: bash
        
           $ cd docs
           $ make html
        
        Doing so will only work if you have Sphinx installed, which you can acheive
        through:
        
        .. code-block:: bash
        
           $ pip install -r requirements/docs.txt
        
        Contributing
        ============
        
        We welcome contributions to this library. However, there are a few ground
        rules contributors should be aware of.
        
        License
        -------
        This project is licensed under the Apache v2.0 License. As such, your
        contributions, once accepted, are automatically covered by this license.
        
        Commit messages
        ---------------
        Write decent commit messages. Don't use swear words and refrain from
        uninformative commit messages as 'fixed typo'.
        
        The preferred format of a commit message:
        
        ::
        
            docs/quickstart: Fixed a typo in the Nodes section.
        
            If needed, elaborate further on this commit. Feel free to write a
            complete blog post here if that helps us understand what this is
            all about.
        
            Fixes #4 and resolves #2.
        
        If you'd like a more elaborate guide on how to write and format your commit
        messages have a look at this post by `Tim Pope`_.
        
        .. _Tim Pope: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
        
        Tests
        -----
        Commits are expected to contain tests or updates to tests if they add to or
        modify the current behaviour.
        
        The test suite is powered by `pytest`_ and requires `pytest`_, `pytest-pep8`_,
        `httpretty`_ and `pytest-httpretty`_ which will be installed for you if you
        run:
        
        .. code-block:: bash
        
           $ pip install -r requirements/tests.txt
        
        .. _pytest: http://pytest.org/latest/
        .. _pytest-pep8: https://pypi.python.org/pypi/pytest-pep8
        .. _httpretty: https://pypi.python.org/pypi/httpretty/
        .. _pytest-httpretty: https://github.com/papaeye/pytest-httpretty
        
        To run the unit tests (the ones that don't require a live PuppetDB):
        
        .. code-block:: bash
           
           $ py.test -v -m unit
        
        If the tests pass, you're golden. If not we'll have to figure out why and
        fix that. Feel free to ask for help on this.
        
        .. _Java: http://www.java.com/en/
        .. _Leiningen: https://github.com/technomancy/leiningen/wiki/Packaging
        
        
Keywords: puppet puppetdb
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Software Development :: Libraries
