qksh 1.1.dev14

f5 qksh
================

Introduction
------------
This project implements an SDK for the iControl REST interface for BIG-IP®.
Users of this library can create, edit, update, and delete configuration objects
on a BIG-IP®.

This project implements an utility for interacting with F5 iHealth. Users of
this utility can upload qkview, download log file, config file and command
output from an iHealth link.


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

.. code:: shell

$> pip install qksh


Usage
-----

.. code:: python

qksh <case number> <qkview file list>

qksh 1-12345678 test-1.qkview test-2.qkview

qksh <file/command url of iHealth>

qksh https://ihealth.f5.com/qkview-analyzer/qv/1234567/files/download
/Y29uZmlnL2JpZ2lwLmNvbmY


Documentation
-------------
Documentation is hosted on `Read the Docs <https://qksh.readthedocs.org>`_


Filing Issues
-------------
See the Issues section of `Contributing <CONTRIBUTING.md>`__.


Contributing
------------
See `Contributing <CONTRIBUTING.md>`__

Test
----
Before you open a pull request, your code must have passing
`pytest <http://pytest.org>`__ unit tests. In addition, you should
include a set of functional tests written to use a real BIG-IP device
for testing. Information on how to run our set of tests is included
below.

Unit Tests
~~~~~~~~~~
We use pytest for our unit tests.

#. If you haven't already, install the required test packages listed in
requirements.test.txt in your virtual environment.

.. code:: shell

$ pip install -r requirements.test.txt

#. Run the tests and produce a coverage report. The ``--cov-report=html`` will
create a ``htmlcov/`` directory that you can view in your browser to see the
missing lines of code.

.. code:: shell

py.test --cov ./qksh --cov-report=html
open htmlcov/index.html


Style Checks
~~~~~~~~~~~~
We use the hacking module for our style checks (installed as part of step 1 in
the Unit Test section).

.. code:: shell

$ flake8 ./


Contact
-------
abc89d@gmail.com


License
-------

The MIT License (MIT)
~~~~~~~~~~~
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.