vulnotes 0.1.0__py3-none-any.whl

vulnotes-0.1.0.dist-info/METADATA

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: vulnotes
+Version: 0.1.0
+Summary: Official Python SDK for the Vulnotes API
+Project-URL: Homepage, https://vulnotes.com
+Project-URL: Documentation, https://docs.vulnotes.com
+Project-URL: Repository, https://github.com/vulnotes/vulnotes-python-sdk
+Author: Vulnotes
+License: MIT License
+        
+        Copyright (c) 2026 Vulnotes
+        
+        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.
+License-File: LICENSE
+Keywords: api,pentest,reporting,sdk,vulnerability,vulnotes
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: requests>=2.28
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# vulnotes-python-sdk
+
+Python client for the [Vulnotes](https://vulnotes.com) REST API.
+
+```bash
+pip install vulnotes
+```
+
+Needs Python 3.9 or later. The only dependency is `requests`.
+
+## Getting started
+
+Create an API key in Vulnotes under Settings > API Keys, then:
+
+```python
+from vulnotes import VulnotesClient
+
+client = VulnotesClient("https://acme.vulnotes.app", api_key="vuln_sk_...")
+
+report = client.reports.create("External pentest Q3", language="EN")
+
+client.findings.add(report["_id"], {
+    "title": "SQL Injection in /login",
+    "severity": "Critical",
+    "cvss": {"vector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H"},
+    "data": {"EN": {"title": "SQL Injection in /login", "description": "..."}},
+})
+```
+
+If `VULNOTES_URL` and `VULNOTES_API_KEY` are set in the environment you can just do `VulnotesClient()`.
+
+Methods return plain dicts and lists matching the API's JSON. File exports return bytes. If you're wondering what a key is allowed to do, `client.api_keys.me()` tells you.
+
+## What's covered
+
+Everything reachable with an API key: reports and findings, companies, the vulnerability library, vulnerability templates, report templates, snapshots and review comments, notes, image/attachment uploads, exports (PDF, DOCX, XLSX, ZIP, JSON), the planning calendar, and the AI endpoints. Full endpoint reference: [docs.vulnotes.com](https://docs.vulnotes.com).
+
+Anything not wrapped yet can still be called directly:
+
+```python
+client.request("GET", f"/reports/{report_id}/snapshots")
+```
+
+## A few common tasks
+
+Iterating without dealing with pages:
+
+```python
+for report in client.reports.iter():
+    print(report["title"])
+```
+
+Feeding scanner results into a report:
+
+```python
+for issue in results:
+    client.findings.add(report_id, {
+        "title": issue["name"],
+        "severity": issue["severity"],
+        "affectedSystems": issue["hosts"],
+        "data": {"EN": {"title": issue["name"], "description": issue["detail"]}},
+    })
+```
+
+Downloading exports:
+
+```python
+client.reports.export_xlsx(report_id, finding_fields=["title", "severity"], path="findings.xlsx")
+client.reports.archived_pdf(report_id, path="final.pdf")  # PDF stored when the report was completed
+```
+
+Uploading evidence:
+
+```python
+client.images.upload("screenshot.png", report_id=report_id)
+client.attachments.upload("nmap-scan.xml", report_id=report_id)
+```
+
+Dates can be passed as ISO strings or as `datetime.date`/`datetime.datetime`.
+
+## Errors
+
+Everything raised by the SDK inherits from `vulnotes.VulnotesError`. HTTP errors map to subclasses (`NotFoundError`, `PermissionDeniedError`, `RateLimitError`, ...) with `status_code`, `message` and the parsed body attached.
+
+```python
+from vulnotes import NotFoundError
+
+try:
+    client.reports.get(report_id)
+except NotFoundError:
+    # doesn't exist, or the key's owner can't see it
+    ...
+```
+
+A key that lacks the permission an endpoint needs gets a `PermissionDeniedError` naming it. Reports outside the owner's visibility raise `NotFoundError`, not 403; that's intentional on the server side.
+
+Idempotent requests are retried automatically on connection errors and 429/502/503/504. Tune with `max_retries`, `timeout` and `verify_ssl` on the client.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest          # offline, no instance needed
+ruff check .
+```
+
+There's also an integration suite that runs against a real instance. It creates its own fixtures and removes them, but point it at a disposable instance anyway:
+
+```bash
+VULNOTES_TEST_URL=https://dev.example VULNOTES_TEST_API_KEY=vuln_sk_... pytest tests/integration
+```
+
+## License
+
+MIT

vulnotes-0.1.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+vulnotes/__init__.py,sha256=pzvYUV7ETWHsj6U_oGSMHT7fDKRXgoQTvfBOz7pLzN4,1012
+vulnotes/_utils.py,sha256=BcJXb98bGHCvy0UdHitOAYoNLLaEN1q6RdflVDZPpCU,2573
+vulnotes/_version.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+vulnotes/client.py,sha256=L4UjIE_6d_WBnFqNGOOf3GFCofipJffinU_If9uGnzc,8665
+vulnotes/exceptions.py,sha256=oehLpkeUu3n9bhqATfRDqwEVfNiwq1lQwYqcUjgxDVs,3248
+vulnotes/resources/__init__.py,sha256=wZY53VLhe4qVcFszLgBaEG4Ej4Q2t_iy4ACYyaI1K6k,736
+vulnotes/resources/_base.py,sha256=LdB5brmxlyzvV1kbidudaqGQCpURhLShhzW9rtombWo,2129
+vulnotes/resources/ai.py,sha256=k7-9uTOJAgEqY2DUHw-BnurIB-vCLhx7CsvFBrmeP6I,3783
+vulnotes/resources/api_keys.py,sha256=jwAmMt7JX-Avw35J8pVxjkIYQcMQtFfEWe4xbLTWKzM,467
+vulnotes/resources/attachments.py,sha256=4qIYxeNqRLbyL63C-qwcvGJ2-CyR7Lcl6LwNrdUF4Zw,2408
+vulnotes/resources/comments.py,sha256=fXO1cl7vx6-RZgdfDu7UD8g68IznGDBvM-5mBO7bBd4,3360
+vulnotes/resources/companies.py,sha256=JT7dIqeL1V05CRXKs_NkeSgXthjlgEiwzt8j97abgwo,2955
+vulnotes/resources/findings.py,sha256=hd3FGGqr2H6uRJqof0kYWObzRfcCwBXIAq15OrwZwVU,2562
+vulnotes/resources/images.py,sha256=bLDvUrvw3v7Pt32PkBryw3UJLGxMa2pDDjeVBZTbWVg,2995
+vulnotes/resources/notes.py,sha256=XWfOqEwfmbvsw6d25eYNsXsW3vSclJqG8jE0qpFlbPA,2426
+vulnotes/resources/planning.py,sha256=yHDbVjNKGloDHMapuZtEehOdYyP9s3ORx4x_p4GaU10,8056
+vulnotes/resources/report_templates.py,sha256=0VIYIZNz3wjdq6mUAva-D66xkox09MC31xTfnNnErjk,2170
+vulnotes/resources/reports.py,sha256=aTwSDwd875VYWGrkSG_gSUCvt0Oa7BySPHVjayKn_7Y,11073
+vulnotes/resources/snapshots.py,sha256=BwR3BUXthRPBYs_-YJWjyFXTCTrlCWhFft0seIoDqqE,1427
+vulnotes/resources/vulnerabilities.py,sha256=eJePfhy1JTpY_bit5Y-q62qZpgYwks3LfY-18VxA5jk,2933
+vulnotes/resources/vulnerability_templates.py,sha256=kCQhk-nmzknGnFVf0OACR_GRmLmlOSEyTuNMPs5WpRQ,5076
+vulnotes-0.1.0.dist-info/METADATA,sha256=E_640nLyeB5j830wupkmpKfwUmtt71V00x7pIGOR1mI,6065
+vulnotes-0.1.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+vulnotes-0.1.0.dist-info/licenses/LICENSE,sha256=q1AGn8OHsj4hljBl6daSiCIPeP7KNNO7vaUK-GrdoBw,1065
+vulnotes-0.1.0.dist-info/RECORD,,

vulnotes-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

vulnotes-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vulnotes
+
+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.