opsmanager 0.1.0__tar.gz

opsmanager-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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
+
+   Copyright 2024 Frank Snow
+
+   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.

opsmanager-0.1.0/PKG-INFO

@@ -0,0 +1,259 @@
+Metadata-Version: 2.4
+Name: opsmanager
+Version: 0.1.0
+Summary: Python client library for MongoDB Ops Manager API
+Author-email: Frank Snow <frank.snow@mongodb.com>
+Maintainer-email: Frank Snow <frank.snow@mongodb.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/fsnow/python-mongodb-ops-manager
+Project-URL: Documentation, https://github.com/fsnow/python-mongodb-ops-manager#readme
+Project-URL: Repository, https://github.com/fsnow/python-mongodb-ops-manager.git
+Project-URL: Issues, https://github.com/fsnow/python-mongodb-ops-manager/issues
+Keywords: mongodb,ops-manager,cloud-manager,api,client,monitoring,database
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: types-requests>=2.28.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=6.0.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=1.2.0; extra == "docs"
+Dynamic: license-file
+
+# python-mongodb-ops-manager
+
+Python client library for MongoDB Ops Manager API
+
+## Status
+
+**Beta** - Core functionality implemented and tested against live Ops Manager
+
+## Overview
+
+A production-quality Python client library for the MongoDB Ops Manager API, designed to enable automated health checks, metrics collection, and fleet management for MongoDB deployments.
+
+## Features
+
+- **Production-ready** - Built-in rate limiting, error handling, retry logic with exponential backoff
+- **Type-safe** - Full type hints throughout with dataclass models
+- **Pythonic** - Clean, idiomatic Python API design
+- **Safe by default** - Conservative rate limiting to protect production Ops Manager instances
+- **Tested** - Validated against live Ops Manager and cross-checked with mongocli (Go SDK)
+
+## Installation
+
+```bash
+pip install opsmanager
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/fsnow/python-mongodb-ops-manager.git
+cd python-mongodb-ops-manager
+pip install -e .
+```
+
+## Quick Start
+
+```python
+from opsmanager import OpsManagerClient
+
+# Create client
+client = OpsManagerClient(
+    base_url="https://ops-manager.example.com",
+    public_key="your-public-key",
+    private_key="your-private-key",
+)
+
+# List all projects
+projects = client.projects.list()
+for project in projects:
+    print(f"Project: {project.name} ({project.id})")
+
+# Get hosts in a project
+hosts = client.deployments.list_hosts(project_id="your-project-id")
+for host in hosts:
+    print(f"Host: {host.hostname}:{host.port} - {host.replica_state_name}")
+
+# Get metrics for a host (last 24 hours, 1-minute granularity)
+metrics = client.measurements.host(
+    project_id="your-project-id",
+    host_id="host-id",
+    granularity="PT1M",
+    period="P1D",
+    metrics=["OPCOUNTER_QUERY", "OPCOUNTER_INSERT", "CONNECTIONS"],
+)
+
+# Get Performance Advisor suggestions
+suggestions = client.performance_advisor.get_suggested_indexes(
+    project_id="your-project-id",
+    host_id="hostname:27017",
+    duration=86400000,  # 24 hours in milliseconds
+)
+
+# Clean up
+client.close()
+```
+
+### Using as Context Manager
+
+```python
+with OpsManagerClient(
+    base_url="https://ops-manager.example.com",
+    public_key="your-public-key",
+    private_key="your-private-key",
+) as client:
+    projects = client.projects.list()
+```
+
+## API Coverage
+
+### Currently Implemented
+
+| Service | Description |
+|---------|-------------|
+| `organizations` | List organizations, get org details, list projects in org |
+| `projects` | List projects, get project by ID or name |
+| `clusters` | List clusters, get cluster details |
+| `deployments` | List hosts, databases, disks; get by ID or name |
+| `measurements` | Host, database, and disk metrics with time-series data |
+| `performance_advisor` | Namespaces, slow queries, suggested indexes |
+| `alerts` | List alerts, acknowledge alerts |
+
+### Configuration Options
+
+```python
+client = OpsManagerClient(
+    base_url="https://ops-manager.example.com",
+    public_key="your-public-key",
+    private_key="your-private-key",
+    timeout=30.0,           # Request timeout in seconds
+    rate_limit=2.0,         # Max requests per second (conservative default)
+    retry_count=3,          # Number of retries for failed requests
+    retry_backoff=1.0,      # Base backoff time between retries
+    verify_ssl=True,        # Verify SSL certificates
+)
+```
+
+### Rate Limiting
+
+Rate limiting is **built-in and enabled by default** to protect production Ops Manager instances. The default is 2 requests per second, which is conservative but safe.
+
+```python
+# Adjust rate limit if needed (be careful with production systems!)
+client.set_rate_limit(5.0)  # 5 requests per second
+```
+
+### Pagination
+
+All list methods support pagination automatically:
+
+```python
+# Fetch all results (handles pagination internally)
+all_hosts = client.deployments.list_hosts(project_id="abc123")
+
+# Or iterate with automatic pagination
+for host in client.deployments.list_hosts_iter(project_id="abc123"):
+    print(host.hostname)
+```
+
+### Return Types
+
+All methods support returning either typed objects or raw dictionaries:
+
+```python
+# Return typed objects (default)
+hosts = client.deployments.list_hosts(project_id="abc123", as_obj=True)
+print(hosts[0].hostname)  # IDE autocomplete works
+
+# Return raw dictionaries
+hosts = client.deployments.list_hosts(project_id="abc123", as_obj=False)
+print(hosts[0]["hostname"])
+```
+
+## Testing
+
+### Live Integration Tests
+
+Run the integration test suite against a live Ops Manager instance:
+
+```bash
+export OM_BASE_URL="http://ops-manager.example.com:8081"
+export OM_PUBLIC_KEY="your-public-key"
+export OM_PRIVATE_KEY="your-private-key"
+
+python tests/test_live.py --verbose
+```
+
+### Validation Against mongocli
+
+Compare output against the official MongoDB CLI (uses the Go SDK):
+
+```bash
+export OM_ORG_ID="your-org-id"
+export OM_PROJECT_ID="your-project-id"
+
+python tests/validate_against_mongocli.py
+```
+
+## Design Principles
+
+This library is modeled after the official [MongoDB Go SDK](https://github.com/mongodb/go-client-mongodb-ops-manager) with Pythonic adaptations:
+
+1. **Service-oriented architecture** - Logical grouping of API endpoints
+2. **Explicit over implicit** - Project ID passed per-call, not stored globally
+3. **Safe defaults** - Rate limiting and SSL verification enabled by default
+4. **Flexible output** - Choose between typed objects or raw dictionaries
+
+## Use Cases
+
+- Automated health check reporting for large MongoDB fleets
+- Metrics collection and statistical analysis
+- Performance advisor recommendations aggregation
+- Cluster topology documentation
+- Operational automation and scripting
+
+## Inspiration
+
+- **Go SDK**: [go-client-mongodb-ops-manager](https://github.com/mongodb/go-client-mongodb-ops-manager) - Official MongoDB Go client
+- **Python**: [atlasapi](https://pypi.org/project/atlasapi/) - Community Atlas API library
+
+## Requirements
+
+- Python 3.9+
+- `requests` library
+
+## License
+
+Apache License 2.0 - See [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions welcome! Please open an issue or pull request.
+
+## Disclaimer
+
+This is an independent project and is not officially affiliated with or endorsed by MongoDB, Inc.

opsmanager-0.1.0/README.md

@@ -0,0 +1,215 @@
+# python-mongodb-ops-manager
+
+Python client library for MongoDB Ops Manager API
+
+## Status
+
+**Beta** - Core functionality implemented and tested against live Ops Manager
+
+## Overview
+
+A production-quality Python client library for the MongoDB Ops Manager API, designed to enable automated health checks, metrics collection, and fleet management for MongoDB deployments.
+
+## Features
+
+- **Production-ready** - Built-in rate limiting, error handling, retry logic with exponential backoff
+- **Type-safe** - Full type hints throughout with dataclass models
+- **Pythonic** - Clean, idiomatic Python API design
+- **Safe by default** - Conservative rate limiting to protect production Ops Manager instances
+- **Tested** - Validated against live Ops Manager and cross-checked with mongocli (Go SDK)
+
+## Installation
+
+```bash
+pip install opsmanager
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/fsnow/python-mongodb-ops-manager.git
+cd python-mongodb-ops-manager
+pip install -e .
+```
+
+## Quick Start
+
+```python
+from opsmanager import OpsManagerClient
+
+# Create client
+client = OpsManagerClient(
+    base_url="https://ops-manager.example.com",
+    public_key="your-public-key",
+    private_key="your-private-key",
+)
+
+# List all projects
+projects = client.projects.list()
+for project in projects:
+    print(f"Project: {project.name} ({project.id})")
+
+# Get hosts in a project
+hosts = client.deployments.list_hosts(project_id="your-project-id")
+for host in hosts:
+    print(f"Host: {host.hostname}:{host.port} - {host.replica_state_name}")
+
+# Get metrics for a host (last 24 hours, 1-minute granularity)
+metrics = client.measurements.host(
+    project_id="your-project-id",
+    host_id="host-id",
+    granularity="PT1M",
+    period="P1D",
+    metrics=["OPCOUNTER_QUERY", "OPCOUNTER_INSERT", "CONNECTIONS"],
+)
+
+# Get Performance Advisor suggestions
+suggestions = client.performance_advisor.get_suggested_indexes(
+    project_id="your-project-id",
+    host_id="hostname:27017",
+    duration=86400000,  # 24 hours in milliseconds
+)
+
+# Clean up
+client.close()
+```
+
+### Using as Context Manager
+
+```python
+with OpsManagerClient(
+    base_url="https://ops-manager.example.com",
+    public_key="your-public-key",
+    private_key="your-private-key",
+) as client:
+    projects = client.projects.list()
+```
+
+## API Coverage
+
+### Currently Implemented
+
+| Service | Description |
+|---------|-------------|
+| `organizations` | List organizations, get org details, list projects in org |
+| `projects` | List projects, get project by ID or name |
+| `clusters` | List clusters, get cluster details |
+| `deployments` | List hosts, databases, disks; get by ID or name |
+| `measurements` | Host, database, and disk metrics with time-series data |
+| `performance_advisor` | Namespaces, slow queries, suggested indexes |
+| `alerts` | List alerts, acknowledge alerts |
+
+### Configuration Options
+
+```python
+client = OpsManagerClient(
+    base_url="https://ops-manager.example.com",
+    public_key="your-public-key",
+    private_key="your-private-key",
+    timeout=30.0,           # Request timeout in seconds
+    rate_limit=2.0,         # Max requests per second (conservative default)
+    retry_count=3,          # Number of retries for failed requests
+    retry_backoff=1.0,      # Base backoff time between retries
+    verify_ssl=True,        # Verify SSL certificates
+)
+```
+
+### Rate Limiting
+
+Rate limiting is **built-in and enabled by default** to protect production Ops Manager instances. The default is 2 requests per second, which is conservative but safe.
+
+```python
+# Adjust rate limit if needed (be careful with production systems!)
+client.set_rate_limit(5.0)  # 5 requests per second
+```
+
+### Pagination
+
+All list methods support pagination automatically:
+
+```python
+# Fetch all results (handles pagination internally)
+all_hosts = client.deployments.list_hosts(project_id="abc123")
+
+# Or iterate with automatic pagination
+for host in client.deployments.list_hosts_iter(project_id="abc123"):
+    print(host.hostname)
+```
+
+### Return Types
+
+All methods support returning either typed objects or raw dictionaries:
+
+```python
+# Return typed objects (default)
+hosts = client.deployments.list_hosts(project_id="abc123", as_obj=True)
+print(hosts[0].hostname)  # IDE autocomplete works
+
+# Return raw dictionaries
+hosts = client.deployments.list_hosts(project_id="abc123", as_obj=False)
+print(hosts[0]["hostname"])
+```
+
+## Testing
+
+### Live Integration Tests
+
+Run the integration test suite against a live Ops Manager instance:
+
+```bash
+export OM_BASE_URL="http://ops-manager.example.com:8081"
+export OM_PUBLIC_KEY="your-public-key"
+export OM_PRIVATE_KEY="your-private-key"
+
+python tests/test_live.py --verbose
+```
+
+### Validation Against mongocli
+
+Compare output against the official MongoDB CLI (uses the Go SDK):
+
+```bash
+export OM_ORG_ID="your-org-id"
+export OM_PROJECT_ID="your-project-id"
+
+python tests/validate_against_mongocli.py
+```
+
+## Design Principles
+
+This library is modeled after the official [MongoDB Go SDK](https://github.com/mongodb/go-client-mongodb-ops-manager) with Pythonic adaptations:
+
+1. **Service-oriented architecture** - Logical grouping of API endpoints
+2. **Explicit over implicit** - Project ID passed per-call, not stored globally
+3. **Safe defaults** - Rate limiting and SSL verification enabled by default
+4. **Flexible output** - Choose between typed objects or raw dictionaries
+
+## Use Cases
+
+- Automated health check reporting for large MongoDB fleets
+- Metrics collection and statistical analysis
+- Performance advisor recommendations aggregation
+- Cluster topology documentation
+- Operational automation and scripting
+
+## Inspiration
+
+- **Go SDK**: [go-client-mongodb-ops-manager](https://github.com/mongodb/go-client-mongodb-ops-manager) - Official MongoDB Go client
+- **Python**: [atlasapi](https://pypi.org/project/atlasapi/) - Community Atlas API library
+
+## Requirements
+
+- Python 3.9+
+- `requests` library
+
+## License
+
+Apache License 2.0 - See [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions welcome! Please open an issue or pull request.
+
+## Disclaimer
+
+This is an independent project and is not officially affiliated with or endorsed by MongoDB, Inc.