1.. image:: http://cpe.mitre.org/images/cpe_logo.gif
2   :alt: CPE Logo
3
4Common Platform Enumeration for Python
5--------------------------------------
6
7*CPE* (this code) is a LGPL licensed Python package, implementing the
8CPE standards.
9
10
11About the CPE standard
12----------------------
13
14Common Platform Enumeration (CPE) is a standardized method of describing
15and identifying classes of applications, operating systems, and hardware
16devices present among an enterprise's computing assets.
17
18For more information, please visit the official website of CPE,
19developed by `MITRE`_ and maintained by `NIST`_.
20
21
22Features
23--------
24
25- CPE rich comparison.
26- CPE cross-version conversion.
27- CPE Language parsing and evaluation.
28- LGPL Licensed.
29- Semantic versioning.
30- Tests.
31
32
33Installation |Version| |TravisCI_master|
34----------------------------------------
35
36To install `CPE` execute:
37
38.. code-block:: bash
39
40    $ pip install cpe
41
42The latest stable version is always in `PyPI`_.
43
44
45Documentation
46-------------
47
48Documentation is available at `ReadTheDocs`_.
49
50
51Compatibility
52-------------
53
54- Python: 2.7, 3.4
55- CPE: 1.1, 2.2, 2.3
56- CPE Formats: WFN, URI, FS.
57
58
59Contribute |Coverage| |TravisCI_develop| |Waffle.IO_ready|
60----------------------------------------------------------
61
62Follow the steps on the `how to contribute`_ document.
63
64.. _PyPI: https://pypi.python.org/pypi/cpe/
65.. _MITRE: http://cpe.mitre.org/
66.. _NIST: http://nvd.nist.gov/cpe.cfm
67.. _ReadTheDocs: https://cpe.readthedocs.org/en/latest/
68.. _GitHub: https://github.com/nilp0inter/cpe
69.. _How to contribute: https://github.com/nilp0inter/cpe/blob/develop/CONTRIBUTING.md
70
71
72.. |TravisCI_master| image:: https://travis-ci.org/nilp0inter/cpe.svg?branch=master
73   :target: https://travis-ci.org/nilp0inter/cpe
74   :alt: Build Status (master)
75
76
77.. |TravisCI_develop| image:: https://travis-ci.org/nilp0inter/cpe.svg?branch=develop
78   :target: https://travis-ci.org/nilp0inter/cpe
79   :alt: Build Status (develop)
80
81.. |Waffle.IO_ready| image:: https://badge.waffle.io/nilp0inter/cpe.png?label=ready&title=Ready
82   :target: https://waffle.io/nilp0inter/cpe
83   :alt: Stories in Ready
84
85.. |Coverage| image:: https://coveralls.io/repos/nilp0inter/cpe/badge.png?branch=develop
86   :target: https://coveralls.io/r/nilp0inter/cpe?branch=develop
87   :alt: Coverage Status
88
89.. |Downloads| image:: https://pypip.in/d/cpe/badge.png
90   :target: https://crate.io/packages/cpe
91   :alt: Downloads
92
93.. |Version| image:: https://camo.githubusercontent.com/8369bedde5c3455e907e9ddf9b06751af7cbbc28/68747470733a2f2f62616467652e667572792e696f2f70792f6370652e706e67
94   :target: http://badge.fury.io/py/cpe
95   :alt: Version
96