defectdojo-api-generated 2.56.1.post2__tar.gz → 2.56.2__tar.gz

{defectdojo_api_generated-2.56.1.post2 → defectdojo_api_generated-2.56.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: defectdojo-api-generated
-Version: 2.56.1.post2
+Version: 2.56.2
 Summary: Python library to interact with DefectDojo - generated from OpenAPI
 Author-email: Filipe Pina <shelf-corncob-said@duck.com>
 Project-URL: Homepage, https://github.com/fopina/defectdojo-api-generated
@@ -11,6 +11,10 @@ Requires-Dist: pydantic>=2
 Requires-Dist: python-dateutil>=2.8.2
 Requires-Dist: urllib3<3.0.0,>=2.1.0
 Requires-Dist: typing-extensions>=4.7.1
+Provides-Extra: cli
+Requires-Dist: classyclick==0.8.0; extra == "cli"
+Requires-Dist: jmespath>=1.0.1; extra == "cli"
+Requires-Dist: platformdirs>=4.4.0; extra == "cli"
 Dynamic: license-file
 
 # defectdojo-api-generated
@@ -25,25 +29,65 @@ Dynamic: license-file
 
 Python library to interact with DefectDojo - generated from OpenAPI definition using https://openapi-generator.tech/
 
-## Install
+Multiple changes done on top of default openapi-generator:
+* A friendlier Client class
+* Tweak validations to reduce package import time to about 1/3
+* Remove most of pydantic/schema validations due to inconsistencies with actual database schema/requirements (tracked in https://github.com/fopina/defectdojo-api-generated/issues/39)
+* A nice CLI exposing all the API methods <3
+  * installed only as an extra, to keep everything clean when package is used as library only
+
+## Example
+
+### Library
 
 ```
 pip install defectojo-api-generated
 ```
 
-## Usage
-
 ```python
 from defectdojo_api_generated import DefectDojo
 
 # password publicly available in https://github.com/DefectDojo/django-DefectDojo/?tab=readme-ov-file#demo
-# then get API token from https://demo.defectdojo.org/api/key-v2
-dojo = DefectDojo('https://demo.defectdojo.org/', token=...)
+dojo = DefectDojo('https://demo.defectdojo.org/', username='admin', password='...')
 r = dojo.findings_api.list()
 print(r.json())
 ```
 
-## Build
+#### **Full documentation** [in docs](docs/README.md)
+
+### CLI
+
+[![asciicast](https://asciinema.org/a/fIPDy8iYxGL85pXb.svg)](https://asciinema.org/a/fIPDy8iYxGL85pXb)
+
+> [uv](https://docs.astral.sh/uv/) recommended or [pipx](https://github.com/pypa/pipx)
+
+```
+uv tool install 'defectojo-api-generated[cli]'
+```
+
+```
+$ dojo 
+Usage: dojo [OPTIONS] COMMAND [ARGS]...
+
+  DefectDojo CLI
+
+Options:
+  ...
+Commands:
+  api     Interact directly with any API/method
+  config  Show or edit the current CLI configuration
+  status  Quick connectivity check
+```
+
+You can also skip tool install and just run it with:
+
+```
+$ uvx 'defectojo-api-generated[cli]'
+Usage: dojo [OPTIONS] COMMAND [ARGS]...
+...
+```
+
+## Contributing
 
 Check out [CONTRIBUTING.md](CONTRIBUTING.md)
 

{defectdojo_api_generated-2.56.1.post2 → defectdojo_api_generated-2.56.2}/README.md

@@ -10,25 +10,65 @@
 
 Python library to interact with DefectDojo - generated from OpenAPI definition using https://openapi-generator.tech/
 
-## Install
+Multiple changes done on top of default openapi-generator:
+* A friendlier Client class
+* Tweak validations to reduce package import time to about 1/3
+* Remove most of pydantic/schema validations due to inconsistencies with actual database schema/requirements (tracked in https://github.com/fopina/defectdojo-api-generated/issues/39)
+* A nice CLI exposing all the API methods <3
+  * installed only as an extra, to keep everything clean when package is used as library only
+
+## Example
+
+### Library
 
 ```
 pip install defectojo-api-generated
 ```
 
-## Usage
-
 ```python
 from defectdojo_api_generated import DefectDojo
 
 # password publicly available in https://github.com/DefectDojo/django-DefectDojo/?tab=readme-ov-file#demo
-# then get API token from https://demo.defectdojo.org/api/key-v2
-dojo = DefectDojo('https://demo.defectdojo.org/', token=...)
+dojo = DefectDojo('https://demo.defectdojo.org/', username='admin', password='...')
 r = dojo.findings_api.list()
 print(r.json())
 ```
 
-## Build
+#### **Full documentation** [in docs](docs/README.md)
+
+### CLI
+
+[![asciicast](https://asciinema.org/a/fIPDy8iYxGL85pXb.svg)](https://asciinema.org/a/fIPDy8iYxGL85pXb)
+
+> [uv](https://docs.astral.sh/uv/) recommended or [pipx](https://github.com/pypa/pipx)
+
+```
+uv tool install 'defectojo-api-generated[cli]'
+```
+
+```
+$ dojo 
+Usage: dojo [OPTIONS] COMMAND [ARGS]...
+
+  DefectDojo CLI
+
+Options:
+  ...
+Commands:
+  api     Interact directly with any API/method
+  config  Show or edit the current CLI configuration
+  status  Quick connectivity check
+```
+
+You can also skip tool install and just run it with:
+
+```
+$ uvx 'defectojo-api-generated[cli]'
+Usage: dojo [OPTIONS] COMMAND [ARGS]...
+...
+```
+
+## Contributing
 
 Check out [CONTRIBUTING.md](CONTRIBUTING.md)
 

{defectdojo_api_generated-2.56.1.post2 → defectdojo_api_generated-2.56.2}/defectdojo_api_generated/__init__.py

@@ -12,7 +12,7 @@ Generated by OpenAPI Generator (https://openapi-generator.tech)
 Do not edit the class manually.
 """  # noqa: E501
 
-__version__ = '2.56.1.post2'
+__version__ = '2.56.2'
 
 # Define package exports
 __all__ = [
@@ -371,6 +371,7 @@ __all__ = [
     'RiskAcceptance',
     'RiskAcceptanceProof',
     'RiskAcceptanceRequest',
+    'RiskAcceptanceToNotes',
     'Role',
     'SLAConfiguration',
     'SLAConfigurationRequest',
@@ -1024,6 +1025,7 @@ from defectdojo_api_generated.models.report_generate_option_request import (
 from defectdojo_api_generated.models.risk_acceptance import RiskAcceptance as RiskAcceptance
 from defectdojo_api_generated.models.risk_acceptance_proof import RiskAcceptanceProof as RiskAcceptanceProof
 from defectdojo_api_generated.models.risk_acceptance_request import RiskAcceptanceRequest as RiskAcceptanceRequest
+from defectdojo_api_generated.models.risk_acceptance_to_notes import RiskAcceptanceToNotes as RiskAcceptanceToNotes
 from defectdojo_api_generated.models.role import Role as Role
 from defectdojo_api_generated.models.sla_configuration import SLAConfiguration as SLAConfiguration
 from defectdojo_api_generated.models.sla_configuration_request import SLAConfigurationRequest as SLAConfigurationRequest

{defectdojo_api_generated-2.56.1.post2 → defectdojo_api_generated-2.56.2}/defectdojo_api_generated/api/endpoints_api.py

@@ -1011,7 +1011,7 @@ class EndpointsApi:
         o: Annotated[
             Optional[List[StrictStr]],
             Field(
-                description='Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending)'
+                description='Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending) * `active_finding_count` - Active Findings Count * `-active_finding_count` - Active Findings Count (descending)'
             ),
         ] = None,
         offset: Annotated[
@@ -1059,7 +1059,7 @@ class EndpointsApi:
         :type not_tag: str
         :param not_tags: Comma separated list of exact tags not present on model
         :type not_tags: List[str]
-        :param o: Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending)
+        :param o: Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending) * `active_finding_count` - Active Findings Count * `-active_finding_count` - Active Findings Count (descending)
         :type o: List[str]
         :param offset: The initial index from which to return the results.
         :type offset: int
@@ -1152,7 +1152,7 @@ class EndpointsApi:
         o: Annotated[
             Optional[List[StrictStr]],
             Field(
-                description='Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending)'
+                description='Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending) * `active_finding_count` - Active Findings Count * `-active_finding_count` - Active Findings Count (descending)'
             ),
         ] = None,
         offset: Annotated[
@@ -1200,7 +1200,7 @@ class EndpointsApi:
         :type not_tag: str
         :param not_tags: Comma separated list of exact tags not present on model
         :type not_tags: List[str]
-        :param o: Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending)
+        :param o: Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending) * `active_finding_count` - Active Findings Count * `-active_finding_count` - Active Findings Count (descending)
         :type o: List[str]
         :param offset: The initial index from which to return the results.
         :type offset: int
@@ -1293,7 +1293,7 @@ class EndpointsApi:
         o: Annotated[
             Optional[List[StrictStr]],
             Field(
-                description='Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending)'
+                description='Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending) * `active_finding_count` - Active Findings Count * `-active_finding_count` - Active Findings Count (descending)'
             ),
         ] = None,
         offset: Annotated[
@@ -1341,7 +1341,7 @@ class EndpointsApi:
         :type not_tag: str
         :param not_tags: Comma separated list of exact tags not present on model
         :type not_tags: List[str]
-        :param o: Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending)
+        :param o: Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending) * `active_finding_count` - Active Findings Count * `-active_finding_count` - Active Findings Count (descending)
         :type o: List[str]
         :param offset: The initial index from which to return the results.
         :type offset: int
@@ -1553,7 +1553,7 @@ class EndpointsApi:
         o: Annotated[
             Optional[List[StrictStr]],
             Field(
-                description='Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending)'
+                description='Ordering  * `host` - Host * `-host` - Host (descending) * `product` - Product * `-product` - Product (descending) * `id` - Id * `-id` - Id (descending) * `active_finding_count` - Active Findings Count * `-active_finding_count` - Active Findings Count (descending)'
             ),
         ] = None,
         offset: Annotated[