Metadata-Version: 2.1
Name: orgcrawler.payload
Version: 0.0.1
Summary: A library of orgcrawler payload functions
Home-page: https://github.com/ucopacme/orgcrawler-payload
Author: Ashley Gould - University of California Office of the President
Author-email: agould@ucop.edu
License: GPLv3
Keywords: aws organizations boto3 orgcrawler
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
Requires-Dist: botocore
Requires-Dist: boto3
Requires-Dist: orgcrawler


OrgCrawler Payloads
===================

A library of curated orgcrawler payload functions.

orgcrawler-payload is a sub-package within the OrgCrawler_ namespace.  See
the `Orgcrawler Readthedocs`_ page for full documentation of the OrgCrawler
suite of tools.


Installation
------------

::

  pip install orgcrawler-payload


Package Organization
--------------------

**orgcrawler.payload**
  The modules in ``orgcrawler.payload`` contain fully tested and supported
  payload functions divided accourding to AWS service

**orgcrawler.untested_payload**
  The modules in ``orgcrawler.untested_payload`` contain untested or
  experimental payload functions.  Many of these functions lack unittests only
  because the `Moto`_ library we use to mock AWS Services does not yet
  support a particular AWS API.  In time we expect to migrate them into the 
  ``orgcrawler.payload`` collection.

  **WARNING!!** These functions are **NOT** supported.  Use at your own risk.

.. _OrgCrawler: https://github.com/ucopacme/orgcrawler
.. _`OrgCrawler Readthedocs`: https://orgcrawler.readthedocs.io/en/latest/
.. _Moto: https://github.com/spulec/moto


