Metadata-Version: 2.1
Name: genie
Version: 3.0.0
Summary: Genie - Main package for Genie infrastructure
Home-page: https://developer.cisco.com/site/pyats/
Author: Cisco Systems Inc.
Author-email: pyats-support-ext@cisco.com
License: Apache 2.0
Keywords: genie pyats test automation
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: dev
Requires-Dist: pyats
Requires-Dist: setuptools
Requires-Dist: wheel
Requires-Dist: genie.abstract
Requires-Dist: genie.metaparser
Requires-Dist: genie.parsergen
Requires-Dist: genie.telemetry
Requires-Dist: genie.conf
Requires-Dist: genie.ops
Requires-Dist: genie.harness
Requires-Dist: genie.examples
Requires-Dist: genie.predcore
Requires-Dist: genie.utils
Requires-Dist: genie.libs.conf
Requires-Dist: genie.libs.ops
Requires-Dist: genie.libs.sdk
Requires-Dist: genie.libs.filetransferutils
Requires-Dist: genie.conf (<3.1.0,>=3.0.0)
Requires-Dist: genie.examples (<3.1.0,>=3.0.0)
Requires-Dist: genie.harness (<3.1.0,>=3.0.0)
Requires-Dist: genie.ops (<3.1.0,>=3.0.0)
Requires-Dist: genie.utils (<3.1.0,>=3.0.0)
Provides-Extra: dev
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: restview; extra == 'dev'
Requires-Dist: Sphinx; extra == 'dev'
Requires-Dist: sphinxcontrib-napoleon; extra == 'dev'
Requires-Dist: sphinx-rtd-theme; extra == 'dev'

Genie
=====

Genie is both a library framework and a test harness that facilitates rapid
development, encourage re-usable and simplify writing test automation. Genie bundled with
the modular architecture of pyATS framework accelerates and simplifies test
automation leveraging all the perks of the Python programming language in an
object-orienting fashion.

pyATS is an end-to-end testing ecosystem, specializing in data-driven and
reusable testing, and engineered to be suitable for Agile, rapid development
iterations. Extensible by design, pyATS enables developers start with small,
simple and linear test cases, and scale towards large, complex and asynchronous
test suites.

Genie was initially developed internally in Cisco, and is now available to the
general public starting early 2018 through `Cisco DevNet`_. Visit the Genie
home page at

    https://developer.cisco.com/site/pyats/

.. _Cisco DevNet: https://developer.cisco.com/


Genie Package
-------------

This is the top-level package of Genie. Installing it will automatically
install all Genie components and dependencies.

Requirements
------------

Genie currently supports Python 3.4+ on Linux & Mac systems. Windows platforms
are not yet supported.

Quick Start
-----------

.. code-block:: console

    # install genie as a whole
    $ pip install genie

    # to upgrade this package manually
    $ pip install --upgrade genie

    # to install alpha/beta versions, add --pre
    $ pip install --pre genie



For more information on setting up your Python development environment,
such as creating virtual environment and installing ``pip`` on your system, 
please refer to `Virtual Environment and Packages`_ in Python tutorials.

.. _Virtual Environment and Packages: https://docs.python.org/3/tutorial/venv.html

Example
-------

As part of installation, examples showcasing various features & idioms of coding
in Genie will be copied to your virtual environment under ``examples/`` folder.

In addition, you can also get a copy of these examples here:
    https://github.com/CiscoDevNet/pyats-sample-scripts TODO

The examples are self-explanatory, and includes the necessary instructions on
how to run them.


