A Python implementation of the KMIP specification.
Go to file
justin-h-loi 0fd1e1f275 Remove old installs and attempt at doc test fix 2023-08-29 16:33:43 -04:00
.github/workflows Remove old installs and attempt at doc test fix 2023-08-29 16:33:43 -04:00
.travis Updated app specific info to be a list of dictionaries, removed unneeded sudo in run.sh, updated server.conf to remove db, updated tests and comments to reflect app specific info being a list 2022-07-25 10:12:56 -04:00
bin Add a Subject Alternative Name to the example server cert. 2022-03-22 14:17:12 -04:00
docs Remove old installs and attempt at doc test fix 2023-08-29 16:33:43 -04:00
examples Rename the 'default' policy section to 'preset' 2018-05-17 13:55:50 -04:00
kmip Fix test_mac_with_cryptographic_failure unit test. 2023-08-11 18:36:27 -04:00
.gitignore Update and clean up .gitignore 2018-02-14 15:55:27 -05:00
.travis.yml Pin PyYAML to <=5.2 2020-02-24 14:36:53 -05:00
CHANGELOG.rst PyKMIP - Release 0.10.0 2020-02-25 11:05:27 -05:00
LICENSE.txt Update the project license, removing an unneeded appendix 2018-02-12 13:49:11 -05: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
doc-requirements.txt Update the documentation to cover auth and access control changes 2018-06-05 09:57:06 -04:00
pytest.ini Updating integration tests to ignore software server 2015-08-20 09:13:20 -04:00
requirements.txt Require enum-compat instead of enum34 2019-08-28 13:31:34 -04:00
setup.py Copy README.rst to long_description 2022-05-17 13:18:56 -04:00
test-requirements.txt Pin PyYAML to <=5.2 2020-02-24 14:36:53 -05:00
tox.ini Remove basepython for non-default tox environments 2019-09-13 16:06:01 -04: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