aceapi-v2-client 2.0.0__tar.gz

aceapi_v2_client-2.0.0/.gitignore

@@ -0,0 +1,20 @@
+# build artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# python
+__pycache__/
+*.py[cod]
+*.so
+.venv/
+venv/
+
+# tooling caches
+.ruff_cache/
+.pytest_cache/
+.mypy_cache/
+
+# regeneration scratch dir (scripts/regenerate.sh)
+.regen/

aceapi_v2_client-2.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

aceapi_v2_client-2.0.0/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: aceapi-v2-client
+Version: 2.0.0
+Summary: Python client library for the ACE (Analysis Correlation Engine) API v2
+Project-URL: Homepage, https://github.com/ACE-Collective/ace
+Project-URL: Repository, https://github.com/ACE-Collective/ace
+Project-URL: Issues, https://github.com/ACE-Collective/ace/issues
+Author: ACE Collective
+License: Apache-2.0
+License-File: LICENSE
+Keywords: ace,analysis-correlation-engine,api-client,security
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software 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: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: httpx<0.29.0,>=0.23.0
+Requires-Dist: python-dateutil>=2.8.0
+Description-Content-Type: text/markdown
+
+# aceapi-v2-client
+
+A Python client library for the **ACE (Analysis Correlation Engine) API v2**.
+
+The client is generated from the API's OpenAPI schema with
+[openapi-python-client](https://github.com/openapi-generators/openapi-python-client),
+so every endpoint and model is fully typed. A small hand-written `auth` module
+adds convenience helpers for ACE's API-key authentication.
+
+## Installation
+
+```bash
+pip install aceapi-v2-client
+```
+
+Or install from a checkout of this directory:
+
+```bash
+pip install .
+```
+
+Requires Python 3.9+.
+
+## Quickstart (API key)
+
+ACE's primary machine-to-machine authentication is an API key sent in the
+`x-ace-auth` header. Use the `authenticated_client` helper to build a client
+with that header pre-populated:
+
+```python
+from aceapi_v2_client.auth import authenticated_client
+from aceapi_v2_client.api.common import ping_common_ping_get
+from aceapi_v2_client.api.observables import (
+    list_observable_types_observable_types_get,
+)
+
+client = authenticated_client(
+    base_url="https://localhost:8443/api/v2",
+    api_key="YOUR-API-KEY",
+    verify_ssl=False,  # development instances use a self-signed certificate
+)
+
+# a simple authenticated health check
+pong = ping_common_ping_get.sync(client=client)
+print(pong.result)  # "pong"
+
+# call a data endpoint — responses are parsed into typed models
+types = list_observable_types_observable_types_get.sync(client=client)
+print(types)
+```
+
+Every endpoint module under `aceapi_v2_client.api.*` exposes four functions:
+
+| function          | returns                          |
+| ----------------- | -------------------------------- |
+| `sync(...)`       | the parsed body (or `None`)      |
+| `sync_detailed(...)` | a `Response` with status + parsed body |
+| `asyncio(...)`    | the parsed body, async           |
+| `asyncio_detailed(...)` | a `Response`, async         |
+
+All take `client=` as a keyword argument plus any path/query/body parameters
+the operation defines.
+
+### Async usage
+
+```python
+import asyncio
+from aceapi_v2_client.auth import authenticated_client
+from aceapi_v2_client.api.common import ping_common_ping_get
+
+client = authenticated_client("https://localhost:8443/api/v2", "YOUR-API-KEY",
+                              verify_ssl=False)
+
+async def main():
+    async with client as c:
+        print(await ping_common_ping_get.asyncio(client=c))
+
+asyncio.run(main())
+```
+
+## Authentication with a JWT token
+
+ACE also supports user login via OAuth2 password flow. Obtain a token from the
+`/auth/token` endpoint, then use the `token_client` helper:
+
+```python
+from aceapi_v2_client.auth import token_client
+
+client = token_client(
+    base_url="https://localhost:8443/api/v2",
+    access_token="eyJhbGci...",   # from POST /auth/token
+    verify_ssl=False,
+)
+```
+
+`token_client` sends the token as `Authorization: Bearer <token>`.
+
+## Base URL and TLS notes
+
+- **The base URL must include the `/api/v2` prefix.** The generated client
+  appends operation paths (e.g. `/common/ping`) directly to `base_url`.
+  - From inside the docker compose network: `https://ace-http/api/v2`
+  - From the docker host: `https://localhost:8443/api/v2`
+- Development instances serve a **self-signed certificate**. Pass
+  `verify_ssl=False` (as above) or point `verify_ssl` at a CA bundle path for
+  production.
+
+## Keeping the client up to date
+
+The generated code is committed to this repository. When the ACE API v2 changes,
+regenerate it from the live schema:
+
+```bash
+# against the default instance (https://ace-http/api/v2/openapi.json)
+scripts/regenerate.sh
+
+# or against a specific instance
+scripts/regenerate.sh https://localhost:8443/api/v2/openapi.json
+```
+
+The script:
+
+1. fetches the latest `openapi.json` into this directory (the build-time source
+   of truth),
+2. installs `openapi-python-client` into a throwaway virtualenv (so it never
+   touches your main environment),
+3. regenerates the package, preserving the hand-maintained files
+   (`aceapi_v2_client/auth.py` and `aceapi_v2_client/py.typed`).
+
+After running it:
+
+1. **Review the diff**: `git diff aceapi_v2_client/`
+2. **Bump the version** if the API changed — update `version` in
+   `pyproject.toml` and `package_version_override` in
+   `openapi-python-client-config.yaml`. The client version mirrors the API's
+   major version (`2.x.y`); bump the patch/minor for client-only changes.
+3. **Rebuild and verify** (below).
+
+> Only `auth.py` and `py.typed` are hand-maintained. Do not add other custom
+> code inside `aceapi_v2_client/` — it would be overwritten on regeneration.
+
+## Building and publishing to PyPI
+
+```bash
+pip install -r requirements-dev.txt
+python -m build              # produces dist/*.whl and dist/*.tar.gz
+twine check dist/*           # validate metadata for PyPI
+twine upload dist/*          # publish (requires PyPI credentials)
+```
+
+## Running the smoke test
+
+The smoke test only runs when pointed at a live instance:
+
+```bash
+ACE_API_BASE_URL=https://ace-http/api/v2 \
+ACE_API_KEY=YOUR-API-KEY \
+ACE_API_VERIFY_SSL=false \
+pytest tests/test_smoke.py -v
+```
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

aceapi_v2_client-2.0.0/README.md

@@ -0,0 +1,164 @@
+# aceapi-v2-client
+
+A Python client library for the **ACE (Analysis Correlation Engine) API v2**.
+
+The client is generated from the API's OpenAPI schema with
+[openapi-python-client](https://github.com/openapi-generators/openapi-python-client),
+so every endpoint and model is fully typed. A small hand-written `auth` module
+adds convenience helpers for ACE's API-key authentication.
+
+## Installation
+
+```bash
+pip install aceapi-v2-client
+```
+
+Or install from a checkout of this directory:
+
+```bash
+pip install .
+```
+
+Requires Python 3.9+.
+
+## Quickstart (API key)
+
+ACE's primary machine-to-machine authentication is an API key sent in the
+`x-ace-auth` header. Use the `authenticated_client` helper to build a client
+with that header pre-populated:
+
+```python
+from aceapi_v2_client.auth import authenticated_client
+from aceapi_v2_client.api.common import ping_common_ping_get
+from aceapi_v2_client.api.observables import (
+    list_observable_types_observable_types_get,
+)
+
+client = authenticated_client(
+    base_url="https://localhost:8443/api/v2",
+    api_key="YOUR-API-KEY",
+    verify_ssl=False,  # development instances use a self-signed certificate
+)
+
+# a simple authenticated health check
+pong = ping_common_ping_get.sync(client=client)
+print(pong.result)  # "pong"
+
+# call a data endpoint — responses are parsed into typed models
+types = list_observable_types_observable_types_get.sync(client=client)
+print(types)
+```
+
+Every endpoint module under `aceapi_v2_client.api.*` exposes four functions:
+
+| function          | returns                          |
+| ----------------- | -------------------------------- |
+| `sync(...)`       | the parsed body (or `None`)      |
+| `sync_detailed(...)` | a `Response` with status + parsed body |
+| `asyncio(...)`    | the parsed body, async           |
+| `asyncio_detailed(...)` | a `Response`, async         |
+
+All take `client=` as a keyword argument plus any path/query/body parameters
+the operation defines.
+
+### Async usage
+
+```python
+import asyncio
+from aceapi_v2_client.auth import authenticated_client
+from aceapi_v2_client.api.common import ping_common_ping_get
+
+client = authenticated_client("https://localhost:8443/api/v2", "YOUR-API-KEY",
+                              verify_ssl=False)
+
+async def main():
+    async with client as c:
+        print(await ping_common_ping_get.asyncio(client=c))
+
+asyncio.run(main())
+```
+
+## Authentication with a JWT token
+
+ACE also supports user login via OAuth2 password flow. Obtain a token from the
+`/auth/token` endpoint, then use the `token_client` helper:
+
+```python
+from aceapi_v2_client.auth import token_client
+
+client = token_client(
+    base_url="https://localhost:8443/api/v2",
+    access_token="eyJhbGci...",   # from POST /auth/token
+    verify_ssl=False,
+)
+```
+
+`token_client` sends the token as `Authorization: Bearer <token>`.
+
+## Base URL and TLS notes
+
+- **The base URL must include the `/api/v2` prefix.** The generated client
+  appends operation paths (e.g. `/common/ping`) directly to `base_url`.
+  - From inside the docker compose network: `https://ace-http/api/v2`
+  - From the docker host: `https://localhost:8443/api/v2`
+- Development instances serve a **self-signed certificate**. Pass
+  `verify_ssl=False` (as above) or point `verify_ssl` at a CA bundle path for
+  production.
+
+## Keeping the client up to date
+
+The generated code is committed to this repository. When the ACE API v2 changes,
+regenerate it from the live schema:
+
+```bash
+# against the default instance (https://ace-http/api/v2/openapi.json)
+scripts/regenerate.sh
+
+# or against a specific instance
+scripts/regenerate.sh https://localhost:8443/api/v2/openapi.json
+```
+
+The script:
+
+1. fetches the latest `openapi.json` into this directory (the build-time source
+   of truth),
+2. installs `openapi-python-client` into a throwaway virtualenv (so it never
+   touches your main environment),
+3. regenerates the package, preserving the hand-maintained files
+   (`aceapi_v2_client/auth.py` and `aceapi_v2_client/py.typed`).
+
+After running it:
+
+1. **Review the diff**: `git diff aceapi_v2_client/`
+2. **Bump the version** if the API changed — update `version` in
+   `pyproject.toml` and `package_version_override` in
+   `openapi-python-client-config.yaml`. The client version mirrors the API's
+   major version (`2.x.y`); bump the patch/minor for client-only changes.
+3. **Rebuild and verify** (below).
+
+> Only `auth.py` and `py.typed` are hand-maintained. Do not add other custom
+> code inside `aceapi_v2_client/` — it would be overwritten on regeneration.
+
+## Building and publishing to PyPI
+
+```bash
+pip install -r requirements-dev.txt
+python -m build              # produces dist/*.whl and dist/*.tar.gz
+twine check dist/*           # validate metadata for PyPI
+twine upload dist/*          # publish (requires PyPI credentials)
+```
+
+## Running the smoke test
+
+The smoke test only runs when pointed at a live instance:
+
+```bash
+ACE_API_BASE_URL=https://ace-http/api/v2 \
+ACE_API_KEY=YOUR-API-KEY \
+ACE_API_VERIFY_SSL=false \
+pytest tests/test_smoke.py -v
+```
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

aceapi_v2_client-2.0.0/aceapi_v2_client/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing ACE API v2"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

aceapi_v2_client-2.0.0/aceapi_v2_client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

aceapi_v2_client-2.0.0/aceapi_v2_client/api/alerts/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""