defectdojo-api-generated 0.0.2__tar.gz → 0.0.3__tar.gz

defectdojo-api-generated-0.0.3/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: defectdojo-api-generated
+Version: 0.0.3
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2
+Requires-Dist: python-dateutil>=2.8.2
+
+# defectdojo-api-generated
+
+[![ci](https://github.com/fopina/defectdojo-api-generated/actions/workflows/publish-main.yml/badge.svg)](https://github.com/fopina/defectdojo-api-generated/actions/workflows/publish-main.yml)
+[![test](https://github.com/fopina/defectdojo-api-generated/actions/workflows/test.yml/badge.svg)](https://github.com/fopina/defectdojo-api-generated/actions/workflows/test.yml)
+[![codecov](https://codecov.io/github/fopina/defectdojo-api-generated/graph/badge.svg)](https://codecov.io/github/fopina/defectdojo-api-generated)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/defectdojo-api-generated.svg)](https://pypi.org/project/defectdojo-api-generated/)
+[![Current version on PyPi](https://img.shields.io/pypi/v/defectdojo-api-generated)](https://pypi.org/project/defectdojo-api-generated/)
+[![Very popular](https://img.shields.io/pypi/dm/defectdojo-api-generated)](https://pypistats.org/packages/defectdojo-api-generated)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Python library to interact with DefectDojo - generated from OpenAPI definition using https://openapi-generator.tech/
+
+## Install
+
+```
+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=...)
+r = dojo.findings_api.findings_list()
+print(r.json())
+```
+
+## Build
+
+Check out [CONTRIBUTING.md](CONTRIBUTING.md)

defectdojo-api-generated-0.0.3/README.md

@@ -0,0 +1,33 @@
+# defectdojo-api-generated
+
+[![ci](https://github.com/fopina/defectdojo-api-generated/actions/workflows/publish-main.yml/badge.svg)](https://github.com/fopina/defectdojo-api-generated/actions/workflows/publish-main.yml)
+[![test](https://github.com/fopina/defectdojo-api-generated/actions/workflows/test.yml/badge.svg)](https://github.com/fopina/defectdojo-api-generated/actions/workflows/test.yml)
+[![codecov](https://codecov.io/github/fopina/defectdojo-api-generated/graph/badge.svg)](https://codecov.io/github/fopina/defectdojo-api-generated)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/defectdojo-api-generated.svg)](https://pypi.org/project/defectdojo-api-generated/)
+[![Current version on PyPi](https://img.shields.io/pypi/v/defectdojo-api-generated)](https://pypi.org/project/defectdojo-api-generated/)
+[![Very popular](https://img.shields.io/pypi/dm/defectdojo-api-generated)](https://pypistats.org/packages/defectdojo-api-generated)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Python library to interact with DefectDojo - generated from OpenAPI definition using https://openapi-generator.tech/
+
+## Install
+
+```
+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=...)
+r = dojo.findings_api.findings_list()
+print(r.json())
+```
+
+## Build
+
+Check out [CONTRIBUTING.md](CONTRIBUTING.md)

{defectdojo-api-generated-0.0.2 → defectdojo-api-generated-0.0.3}/defectdojo_api_generated/__init__.py

@@ -13,7 +13,8 @@ Generated by OpenAPI Generator (https://openapi-generator.tech)
 Do not edit the class manually.
 """  # noqa: E501
 
-__version__ = '0.0.2'
+__version__ = '0.0.3'
+__openapi_version__ = '2.44.1'
 
 # import apis into sdk package
 from defectdojo_api_generated.api.announcements_api import AnnouncementsApi
@@ -88,6 +89,7 @@ from defectdojo_api_generated.api.users_api import UsersApi
 # import ApiClient
 from defectdojo_api_generated.api_response import ApiResponse
 from defectdojo_api_generated.api_client import ApiClient
+from defectdojo_api_generated.client import DefectDojo
 from defectdojo_api_generated.configuration import Configuration
 from defectdojo_api_generated.exceptions import OpenApiException
 from defectdojo_api_generated.exceptions import ApiTypeError

{defectdojo-api-generated-0.0.2 → defectdojo-api-generated-0.0.3}/defectdojo_api_generated/api_client.py

@@ -80,7 +80,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/1.0.0/python'
+        self.user_agent = 'defectdojo-api-generated/1.0.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{defectdojo-api-generated-0.0.2 → defectdojo-api-generated-0.0.3}/defectdojo_api_generated/client.py

@@ -81,20 +81,37 @@ class DefectDojo:
 
     :param base_url: base URL of the DefectDojo instance.
     :param token: API token to use with DefectDojo.
-    :param proxy: proxy required to connect to DefectDojo.
-        Default (None) will use environment settings. Set to False to forcefully disable it.
+        Use this OR auth, not both.
+    :param auth: tuple with username and password for basic authentication with DefectDojo.
+        Use this OR token, not both.
+    :param config: Configuration object to use. If provided, all other parameters are ignored.
     """
 
-    def __init__(self, base_url: str, token: str, proxy=None):
+    def __init__(self, base_url: str, token: str = None, auth: tuple[str] = None, config: Configuration = None):
+        if token is not None and auth is not None:
+            raise ValueError('Provide `token` OR `auth`, not both.')
+        if auth is not None and (not isinstance(auth, tuple) or len(auth) != 2):
+            raise ValueError('`auth` needs to be a tuple with 2 elements, username and password')
+
+        if config is None:
+            # drop last / (if any) as it is already added as part of endpoints
+            kwargs = {'host': base_url.rstrip('/')}
+
+            if token is not None:
+                kwargs.update({'api_key': {'tokenAuth': token}, 'api_key_prefix': {'tokenAuth': 'Token'}})
+            elif auth is not None:
+                kwargs.update({'username': auth[0], 'password': auth[1]})
+
+            self.config = Configuration(**kwargs)
+        else:
+            self.config = config
+
         # TODO: just python-requests as generator library...
-        if proxy is None:
+        if self.config.proxy is None:
             scheme, host, *_ = urlparse(base_url)
             if not proxy_bypass(host):
-                proxy = getproxies().get(scheme)
+                self.config.proxy = getproxies().get(scheme)
 
-        self.config = Configuration(host=base_url, api_key={'tokenAuth': token}, api_key_prefix={'tokenAuth': 'Token'})
-        if proxy:  # exclude False or None
-            self.config.proxy = proxy
         self.api_client = _ApiClient(configuration=self.config)
         self.announcements_api = AnnouncementsApi(self.api_client)
         self.api_token_auth_api = ApiTokenAuthApi(self.api_client)

defectdojo-api-generated-0.0.3/defectdojo_api_generated.egg-info/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: defectdojo-api-generated
+Version: 0.0.3
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2
+Requires-Dist: python-dateutil>=2.8.2
+
+# defectdojo-api-generated
+
+[![ci](https://github.com/fopina/defectdojo-api-generated/actions/workflows/publish-main.yml/badge.svg)](https://github.com/fopina/defectdojo-api-generated/actions/workflows/publish-main.yml)
+[![test](https://github.com/fopina/defectdojo-api-generated/actions/workflows/test.yml/badge.svg)](https://github.com/fopina/defectdojo-api-generated/actions/workflows/test.yml)
+[![codecov](https://codecov.io/github/fopina/defectdojo-api-generated/graph/badge.svg)](https://codecov.io/github/fopina/defectdojo-api-generated)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/defectdojo-api-generated.svg)](https://pypi.org/project/defectdojo-api-generated/)
+[![Current version on PyPi](https://img.shields.io/pypi/v/defectdojo-api-generated)](https://pypi.org/project/defectdojo-api-generated/)
+[![Very popular](https://img.shields.io/pypi/dm/defectdojo-api-generated)](https://pypistats.org/packages/defectdojo-api-generated)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Python library to interact with DefectDojo - generated from OpenAPI definition using https://openapi-generator.tech/
+
+## Install
+
+```
+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=...)
+r = dojo.findings_api.findings_list()
+print(r.json())
+```
+
+## Build
+
+Check out [CONTRIBUTING.md](CONTRIBUTING.md)

defectdojo-api-generated-0.0.2/PKG-INFO

@@ -1,67 +0,0 @@
-Metadata-Version: 2.1
-Name: defectdojo-api-generated
-Version: 0.0.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
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pydantic>=2
-Requires-Dist: python-dateutil>=2.8.2
-
-# WIP
-
-* Map versions to Dojo version - use postfixes for non-schema changes (such as templating or similar)
-* Fix unit tests?
-* Re-enable linting?
-
-## New project checklist
-
-* [ ] Replace folder `example` with the actual package
-* [ ] Replace `LICENSE` if MIT does not apply
-* [ ] Search the project for `# TODO` to find the (minimum list of) places that need to be changed.
-* [ ] Add PYPI credentials to secrets
-    * `PYPI_USERNAME` and `PYPI_TOKEN` to publish tags to pypi
-    * `TESTPYPI_USERNAME` and `TESTPYPI_TOKEN` to publish dev branches to testpypi
-* [ ] Add [codecov](https://app.codecov.io/github/fopina/) token
-    * `CODECOV_TOKEN` taken from link above
-* [ ] Replace this README.md - template below
-
-# fp-github-template-example
-
-[![ci](https://github.com/fopina/python-package-template/actions/workflows/publish-main.yml/badge.svg)](https://github.com/fopina/python-package-template/actions/workflows/publish-main.yml)
-[![test](https://github.com/fopina/python-package-template/actions/workflows/test.yml/badge.svg)](https://github.com/fopina/python-package-template/actions/workflows/test.yml)
-[![codecov](https://codecov.io/github/fopina/python-package-template/graph/badge.svg)](https://codecov.io/github/fopina/python-package-template)
-[![PyPI pyversions](https://img.shields.io/pypi/pyversions/fp-github-template-example.svg)](https://pypi.org/project/fp-github-template-example/)
-[![Current version on PyPi](https://img.shields.io/pypi/v/fp-github-template-example)](https://pypi.org/project/fp-github-template-example/)
-[![Very popular](https://img.shields.io/pypi/dm/fp-github-template-example)](https://pypistats.org/packages/fp-github-template-example)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
-CLI that echos whatever you tell it to.
-
-## Install
-
-```
-pip install fp-github-template-example
-```
-
-## Usage
-
-```
-$ example-cli
-Got nothing to say?
-
-$ example-cli hello
-HELLO right back at ya!
-```
-
-```python
->>> from example import demo
->>> demo.echo('ehlo')
-'EHLO right back at ya!'
-```
-
-## Build
-
-Check out [CONTRIBUTING.md](CONTRIBUTING.md)

defectdojo-api-generated-0.0.2/README.md

@@ -1,55 +0,0 @@
-# WIP
-
-* Map versions to Dojo version - use postfixes for non-schema changes (such as templating or similar)
-* Fix unit tests?
-* Re-enable linting?
-
-## New project checklist
-
-* [ ] Replace folder `example` with the actual package
-* [ ] Replace `LICENSE` if MIT does not apply
-* [ ] Search the project for `# TODO` to find the (minimum list of) places that need to be changed.
-* [ ] Add PYPI credentials to secrets
-    * `PYPI_USERNAME` and `PYPI_TOKEN` to publish tags to pypi
-    * `TESTPYPI_USERNAME` and `TESTPYPI_TOKEN` to publish dev branches to testpypi
-* [ ] Add [codecov](https://app.codecov.io/github/fopina/) token
-    * `CODECOV_TOKEN` taken from link above
-* [ ] Replace this README.md - template below
-
-# fp-github-template-example
-
-[![ci](https://github.com/fopina/python-package-template/actions/workflows/publish-main.yml/badge.svg)](https://github.com/fopina/python-package-template/actions/workflows/publish-main.yml)
-[![test](https://github.com/fopina/python-package-template/actions/workflows/test.yml/badge.svg)](https://github.com/fopina/python-package-template/actions/workflows/test.yml)
-[![codecov](https://codecov.io/github/fopina/python-package-template/graph/badge.svg)](https://codecov.io/github/fopina/python-package-template)
-[![PyPI pyversions](https://img.shields.io/pypi/pyversions/fp-github-template-example.svg)](https://pypi.org/project/fp-github-template-example/)
-[![Current version on PyPi](https://img.shields.io/pypi/v/fp-github-template-example)](https://pypi.org/project/fp-github-template-example/)
-[![Very popular](https://img.shields.io/pypi/dm/fp-github-template-example)](https://pypistats.org/packages/fp-github-template-example)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
-CLI that echos whatever you tell it to.
-
-## Install
-
-```
-pip install fp-github-template-example
-```
-
-## Usage
-
-```
-$ example-cli
-Got nothing to say?
-
-$ example-cli hello
-HELLO right back at ya!
-```
-
-```python
->>> from example import demo
->>> demo.echo('ehlo')
-'EHLO right back at ya!'
-```
-
-## Build
-
-Check out [CONTRIBUTING.md](CONTRIBUTING.md)

defectdojo-api-generated-0.0.2/defectdojo_api_generated.egg-info/PKG-INFO

@@ -1,67 +0,0 @@
-Metadata-Version: 2.1
-Name: defectdojo-api-generated
-Version: 0.0.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
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pydantic>=2
-Requires-Dist: python-dateutil>=2.8.2
-
-# WIP
-
-* Map versions to Dojo version - use postfixes for non-schema changes (such as templating or similar)
-* Fix unit tests?
-* Re-enable linting?
-
-## New project checklist
-
-* [ ] Replace folder `example` with the actual package
-* [ ] Replace `LICENSE` if MIT does not apply
-* [ ] Search the project for `# TODO` to find the (minimum list of) places that need to be changed.
-* [ ] Add PYPI credentials to secrets
-    * `PYPI_USERNAME` and `PYPI_TOKEN` to publish tags to pypi
-    * `TESTPYPI_USERNAME` and `TESTPYPI_TOKEN` to publish dev branches to testpypi
-* [ ] Add [codecov](https://app.codecov.io/github/fopina/) token
-    * `CODECOV_TOKEN` taken from link above
-* [ ] Replace this README.md - template below
-
-# fp-github-template-example
-
-[![ci](https://github.com/fopina/python-package-template/actions/workflows/publish-main.yml/badge.svg)](https://github.com/fopina/python-package-template/actions/workflows/publish-main.yml)
-[![test](https://github.com/fopina/python-package-template/actions/workflows/test.yml/badge.svg)](https://github.com/fopina/python-package-template/actions/workflows/test.yml)
-[![codecov](https://codecov.io/github/fopina/python-package-template/graph/badge.svg)](https://codecov.io/github/fopina/python-package-template)
-[![PyPI pyversions](https://img.shields.io/pypi/pyversions/fp-github-template-example.svg)](https://pypi.org/project/fp-github-template-example/)
-[![Current version on PyPi](https://img.shields.io/pypi/v/fp-github-template-example)](https://pypi.org/project/fp-github-template-example/)
-[![Very popular](https://img.shields.io/pypi/dm/fp-github-template-example)](https://pypistats.org/packages/fp-github-template-example)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
-CLI that echos whatever you tell it to.
-
-## Install
-
-```
-pip install fp-github-template-example
-```
-
-## Usage
-
-```
-$ example-cli
-Got nothing to say?
-
-$ example-cli hello
-HELLO right back at ya!
-```
-
-```python
->>> from example import demo
->>> demo.echo('ehlo')
-'EHLO right back at ya!'
-```
-
-## Build
-
-Check out [CONTRIBUTING.md](CONTRIBUTING.md)