1Metadata-Version: 1.1 2Name: vulndb 3Version: 0.0.19 4Summary: Provides access to the vulndb information 5Home-page: https://github.com/vulndb/python-sdk/ 6Author: Andres Riancho 7Author-email: andres@tagcube.io 8License: BSD 3-clause 9Description: Python SDK to access the `vulnerability database <https://github.com/vulndb/data>`_ 10 11 .. image:: https://circleci.com/gh/vulndb/python-sdk/tree/master.svg?style=svg 12 :alt: Build Status 13 :align: right 14 :target: https://circleci.com/gh/vulndb/python-sdk/tree/master 15 16 Installation 17 ============ 18 It's possible to install `the latest stable release from pypi <https://pypi.python.org/pypi/vulndb>`_: 19 20 :: 21 22 pip install vulndb 23 24 25 Or if you're interested in the latest version from our repository: 26 27 :: 28 29 git clone https://github.com/vulndb/python-sdk.git 30 python setup.py install 31 32 Usage 33 ===== 34 35 :: 36 37 >>> from vulndb import DBVuln 38 >>> dbv = DBVuln.from_id(42) 39 >>> dbv.title 40 'SQL Injection' 41 >>> dbv.description 42 'A long and actionable description for SQL injection ...' 43 >>> dbv.fix_guidance 44 'Explains the developer how to fix SQL injections, usually a couple of <p> long ...' 45 >>> dbv.severity 46 'high' 47 >>> r = dbv.references[0] 48 >>> r.url 49 'http://example.com/sqli-description.html' 50 >>> r.title 51 'SQL injection cheat-sheet' 52 53 54 More attributes, methods and helpers are well documented and available in the 55 `source code <https://github.com/vulndb/python-sdk/blob/master/vulndb/db_vuln.py>`_. 56 57 Contributing 58 ============ 59 Send your `pull requests <https://help.github.com/articles/using-pull-requests/>`_ 60 with improvements and bug fixes, making sure that all tests ``PASS``: 61 62 :: 63 64 $ cd python-sdk 65 $ virtualenv venv 66 $ . venv/bin/activate 67 $ pip install -r vulndb/requirements-dev.txt 68 $ nosetests vulndb/ 69 .......... 70 ---------------------------------------------------------------------- 71 Ran 10 tests in 0.355s 72 73 OK 74 75 76 Updating the database 77 ===================== 78 This package embeds the `vulnerability database <https://github.com/vulndb/data>`_ 79 in the ``vulndb/db/`` directory. To update the database with new information 80 follow these steps: 81 82 :: 83 84 # Update the database 85 tools/update-db.sh 86 87 After updating the database it's a good idea to publish the latest at ``pypi`` using: 88 89 :: 90 91 python setup.py sdist upload 92 93 94 95Platform: Linux 96Classifier: Development Status :: 5 - Production/Stable 97Classifier: Intended Audience :: Developers 98Classifier: License :: OSI Approved :: BSD License 99Classifier: Natural Language :: English 100Classifier: Operating System :: POSIX :: Linux 101Classifier: Operating System :: Microsoft :: Windows 102Classifier: Programming Language :: Python 103Classifier: Programming Language :: Python :: 2.7 104Classifier: Topic :: Security 105