PyKMIP

A Python implementation of the KMIP specification.

Go to file

Peter Hamilton 8db92c32b9 Update README to align with new project documentation This change updates the project README, dropping most of the old README content and replacing it with snippets taken from the new project documentation. Users and developers should reference the project docs as their main source of information from now on.		2017-12-07 10:52:38 -05:00
bin	Added KMIP Server Entry Point	2016-04-11 10:27:57 -04:00
docs	Update the Travis CI config to test doc building	2017-11-17 15:18:53 -05:00
examples	Add a logging level configuration option	2017-09-27 17:41:14 -04:00
kmip	Update the PyKMIP library version to 0.8.dev	2017-11-15 14:21:52 -05:00
.gitignore	Updating .gitignore to ignore build directories	2016-12-02 13:54:21 -05:00
.travis.yml	Update the Travis CI config to test doc building	2017-11-17 15:18:53 -05:00
CHANGELOG.rst	Add Sphinx documentation	2017-11-17 13:50:52 -05:00
LICENSE.txt	PyKMIP - Release v0.0.1	2014-08-13 19:23:05 -04:00
MANIFEST.in	Adding server key and cert files to installation	2014-12-10 18:43:56 -05:00
README.rst	Update README to align with new project documentation	2017-12-07 10:52:38 -05:00
pytest.ini	Updating integration tests to ignore software server	2015-08-20 09:13:20 -04:00
requirements.txt	Update requirements to match required features	2017-07-07 08:26:02 -04:00
setup.py	Update the PyKMIP library version to 0.8.dev	2017-11-15 14:21:52 -05:00
test-requirements.txt	Temporarily pin pytest to <3.3	2017-12-04 10:51:56 -05:00
tox.ini	Add Sphinx documentation	2017-11-17 13:50:52 -05:00

README.rst

------
PyKMIP
------
|pypi-version|
|travis-status|
|codecov-status|
|python-versions|

PyKMIP is a Python implementation of the Key Management Interoperability
Protocol (KMIP), an `OASIS`_ communication standard for the management of
objects stored and maintained by key management systems. KMIP defines how key
management operations and operation data should be encoded and communicated
between client and server applications. Supported operations include the full
`CRUD`_ key management lifecycle, including operations for managing object
metadata and for conducting cryptographic operations. Supported object types
include:

* symmetric/asymmetric encryption keys
* passwords/passphrases
* certificates
* opaque data blobs, and more

For more information on KMIP, check out the `OASIS KMIP Technical Committee`_
and the `OASIS KMIP Documentation`_.

For more information on PyKMIP, check out the project `Documentation`_.

Installation
------------
You can install PyKMIP via ``pip``:

.. code-block:: console

    $ pip install pykmip

See `Installation`_ for more information.

Community
---------
The PyKMIP community has various forums and resources you can use:

* `Source code`_
* `Issue tracker`_
* IRC: ``#pykmip`` on ``irc.freenode.net``
* Twitter: ``@pykmip``


.. _`CRUD`: https://en.wikipedia.org/wiki/Create,_read,_update_and_delete
.. _`OASIS`: https://www.oasis-open.org
.. _`OASIS KMIP Technical Committee`: https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=kmip
.. _`OASIS KMIP Documentation`: https://docs.oasis-open.org/kmip/spec/
.. _`Documentation`: https://pykmip.readthedocs.io/en/latest/index.html
.. _`Installation`: https://pykmip.readthedocs.io/en/latest/installation.html
.. _`Source code`: https://github.com/openkmip/pykmip
.. _`Issue tracker`: https://github.com/openkmip/pykmip/issues

.. |pypi-version| image:: https://img.shields.io/pypi/v/pykmip.svg
  :target: https://pypi.python.org/pypi/pykmip
  :alt: Latest Version
.. |travis-status| image:: https://travis-ci.org/OpenKMIP/PyKMIP.svg?branch=master
  :target: https://travis-ci.org/OpenKMIP/PyKMIP
.. |codecov-status| image:: https://codecov.io/github/OpenKMIP/PyKMIP/coverage.svg?branch=master
  :target: https://codecov.io/github/OpenKMIP/PyKMIP?branch=master
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/PyKMIP.svg
  :target: https://github.com/OpenKMIP/PyKMIP