meraki-client 0.1.0__tar.gz

meraki_client-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: Lint and format
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Check formatting
+        run: make format
+
+      - name: Run linter
+        run: make linter
+
+      - name: Run type checker
+        run: make typecheck
+
+      - name: Test building docs
+        run: make docs

meraki_client-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [created]
+
+permissions:
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Verify version matches tag
+        run: |
+          UV_VERSION=$(uv run python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")
+          RELEASE_TAG=${{ github.event.release.tag_name }}
+          CLEAN_TAG=${RELEASE_TAG#v}
+          if [ "$UV_VERSION" != "$CLEAN_TAG" ]; then
+            echo "Version mismatch!"
+            echo "pyproject.toml version: $UV_VERSION"
+            echo "Release tag: $RELEASE_TAG"
+            exit 1
+          fi
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

meraki_client-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+.idea/
+venv/
+.venv
+__pycache__
+/.pytest_cache/
+dist/
+.cache/
+.mypy_cache/
+.ruff_cache/
+.env*
+site/

meraki_client-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

meraki_client-0.1.0/.readthedocs.yml

@@ -0,0 +1,18 @@
+version: 2
+
+mkdocs:
+  configuration: mkdocs.yml
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.11"
+  jobs:
+    pre_create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+    create_environment:
+      - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
+    install:
+      - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group dev

meraki_client-0.1.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+
+- Initial release of meraki-client

meraki_client-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,104 @@
+# Contributing
+
+## Development Setup
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
+
+```shell
+# Install dependencies
+uv sync
+```
+
+## Code Generation
+
+The SDK is auto-generated from Meraki's [OpenAPI specification](https://github.com/meraki/openapi). To regenerate the client code:
+
+```shell
+make generate VERSION=1.66.0
+```
+
+This command:
+
+1. Downloads the OpenAPI spec for the specified version
+2. Generates the `meraki_client` package with sync and async clients
+3. Generates Pydantic response schemas
+4. Generates integration tests in `tests/generated/`
+5. Formats all generated code
+
+See [meraki/openapi releases](https://github.com/meraki/openapi/tags) for available API versions.
+
+### Project Structure
+
+```
+meraki_client/           # Generated client library
+codegen/                 # Code generation
+tests/
+├── test_*.py            # Manual tests
+└── generated/           # Auto-generated tests
+```
+
+### Spec Overrides
+
+Some endpoints have bugs in the OpenAPI spec. Workarounds are configured in `codegen/spec_overrides.toml`. The generator validates that overrides reference existing operations and logs warnings when the spec appears fixed.
+
+## Testing
+
+Tests require a Meraki API key with access to an organization:
+
+```shell
+export MERAKI_DASHBOARD_API_KEY_TESTS=your_api_key
+```
+
+Optionally, specify test resources to avoid auto-discovery:
+
+```shell
+export ORGANIZATION_ID_TESTS=your_org_id
+export NETWORK_ID_TESTS=your_network_id
+export DEVICE_ID_TESTS=your_device_serial
+```
+
+### Running Tests
+
+```shell
+# Run read-only tests (safe)
+make test
+
+# Run mutating tests (creates/updates/deletes resources)
+make test-mutating
+```
+
+### Writing Manual Tests
+
+Manual tests for mutating operations should use the `mutating` marker:
+
+```python
+import pytest
+
+pytestmark = pytest.mark.mutating
+
+def test_create_network() -> None:
+    # Test implementation
+    ...
+```
+
+## Linting
+
+```shell
+# Run all checks (format, lint, typecheck, docs)
+make lint
+```
+
+To auto-fix formatting issues:
+
+```shell
+uv run ruff format meraki_client codegen tests
+uv run ruff check --fix meraki_client codegen tests
+```
+
+## Pull Requests
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run `make lint` and `make test` (if possible)
+5. Submit a pull request

meraki_client-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Cisco Systems, Inc. and/or its affiliates
+Copyright (c) 2026 Olli Paakkunainen
+
+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.

meraki_client-0.1.0/Makefile

@@ -0,0 +1,62 @@
+color := $(shell tput setaf 2)
+off := $(shell tput sgr0)
+TARGETS = meraki_client codegen tests
+
+.PHONY: lint
+lint: format linter typecheck docs
+
+.PHONY: test
+test:
+	@printf '\n\n*****************\n'
+	@printf '$(color)Running tests$(off)\n'
+	@printf '*****************\n'
+	uv run pytest
+
+.PHONY: test-mutating
+test-mutating:
+	@printf '\n\n*****************\n'
+	@printf '$(color)Running mutating tests$(off)\n'
+	@printf '*****************\n'
+	uv run pytest -m mutating
+
+.PHONY: typecheck
+typecheck:
+	@printf '\n\n*****************\n'
+	@printf '$(color)Running type checker$(off)\n'
+	@printf '*****************\n'
+	uv run ty check ${TARGETS}
+
+.PHONY: format
+format:
+	@printf '\n\n*****************\n'
+	@printf '$(color)Running format$(off)\n'
+	@printf '*****************\n'
+	uv run ruff format --check ${TARGETS}
+
+.PHONY: linter
+linter:
+	@printf '\n\n*****************\n'
+	@printf '$(color)Running linter$(off)\n'
+	@printf '*****************\n'
+	uv run ruff check ${TARGETS}
+
+.PHONY: generate
+generate:
+ifndef VERSION
+	$(error VERSION is required. Usage: make generate VERSION=1.66.0)
+endif
+	@printf '\n\n*****************\n'
+	@printf '$(color)Generating SDK$(off)\n'
+	@printf '*****************\n'
+	@uv run python codegen/main.py -v $(VERSION)
+
+.PHONY: docs
+docs:
+	@printf '\n\n*****************\n'
+	@printf '$(color)Test building docs$(off)\n'
+	@printf '*****************\n'
+	uv run mkdocs build --strict
+
+.PHONY: serve
+serve:
+	uv run mkdocs serve --open --livereload

meraki_client-0.1.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: meraki-client
+Version: 0.1.0
+Summary: Python client for Meraki Dashboard API
+Project-URL: homepage, https://github.com/ollipa/meraki-client-python
+Project-URL: repository, https://github.com/ollipa/meraki-client-python
+Author-email: Olli Paakkunainen <olli@paakkunainen.fi>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cisco,dashboard,meraki
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.15
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx<0.29.0,>=0.28.1
+Requires-Dist: pydantic<3.0.0,>=2.12.5
+Description-Content-Type: text/markdown
+
+<p align="center"><strong>Meraki Client</strong> <em>- Python client for Meraki Dashboard API.</em></p>
+
+<p align="center">
+<a href="https://pypi.org/project/meraki-client/">
+  <img src="https://img.shields.io/pypi/v/meraki-client" alt="pypi">
+</a>
+<a href="https://github.com/ollipa/meraki-client-python/actions/workflows/ci.yml">
+  <img src="https://github.com/ollipa/meraki-client-python/actions/workflows/ci.yml/badge.svg" alt="ci">
+</a>
+<a href="https://meraki-client.readthedocs.io/">
+  <img src="https://img.shields.io/readthedocs/meraki-client" alt="documentation">
+</a>
+<a href="./LICENSE">
+  <img src="https://img.shields.io/pypi/l/meraki-client" alt="license">
+</a>
+</p>
+
+<hr>
+
+<p align="center">
+<a href="https://meraki-client.readthedocs.io/">
+  <b>Documentation</b>
+</a>
+</p>
+
+<hr>
+
+Python client for the [Meraki Dashboard API](https://developer.cisco.com/meraki/api-v1/). Auto-generated from the OpenAPI spec to stay current with the latest releases.
+
+**Installation:**
+
+```shell
+pip install meraki-client
+```
+
+## Features
+
+- Modern Python 3.11+ with full type annotations
+- Sync and async clients built on httpx
+- Pydantic models for requests and responses
+- Automatic retries and pagination
+- Full API coverage ([auto-generated from OpenAPI](https://github.com/meraki/openapi))
+
+## Setup
+
+1. Enable API access in your Meraki dashboard organization and [obtain an API key](https://documentation.meraki.com/Platform_Management/Dashboard_Administration/Operate_and_Maintain/How-Tos/Cisco_Meraki_Dashboard_API)
+
+2. Pass the API key to the client, or set it as an environment variable:
+
+   ```python
+   client = MerakiClient(api_key="YOUR_KEY_HERE")
+   ```
+
+   ```shell
+   export MERAKI_DASHBOARD_API_KEY=YOUR_KEY_HERE
+   ```
+
+### Application identification
+
+Cisco Meraki recommends that ecosystem partners and application developers identify their application with API requests. See [User agents guide](https://developer.cisco.com/meraki/api-v1/user-agents-overview/#user-agents) for formatting details.
+
+```python
+client = MerakiClient(caller="ApplicationName/1.0 VendorName")
+```
+
+Or via environment variable:
+
+```shell
+export MERAKI_PYTHON_SDK_CALLER="ApplicationName/1.0 VendorName"
+```
+
+## Usage
+
+API calls follow the pattern `client.<scope>.<operation>()`, where scope maps to the OpenAPI tags (e.g., `organizations`, `networks`, `devices`).
+
+### Synchronous
+
+```python
+from meraki_client import MerakiClient
+
+client = MerakiClient()
+org = client.organizations.get_organization(org_id)
+```
+
+### Asynchronous
+
+```python
+from meraki_client.aio import AsyncMerakiClient
+
+async with AsyncMerakiClient() as client:
+    orgs = await client.organizations.get_organization(org_id)
+```
+
+## Contributing
+
+Contributions are welcome! See [CONTRIBUTING.md](https://github.com/ollipa/meraki-client-python/blob/main/CONTRIBUTING.md) for development setup, testing, and code generation instructions.
+
+## Disclaimer
+
+This is an unofficial community project, not affiliated with or endorsed by Cisco. For the official Meraki Python SDK, see [meraki/dashboard-api-python](https://github.com/meraki/dashboard-api-python). This project was forked from the official Meraki Python SDK.

meraki_client-0.1.0/README.md

@@ -0,0 +1,100 @@
+<p align="center"><strong>Meraki Client</strong> <em>- Python client for Meraki Dashboard API.</em></p>
+
+<p align="center">
+<a href="https://pypi.org/project/meraki-client/">
+  <img src="https://img.shields.io/pypi/v/meraki-client" alt="pypi">
+</a>
+<a href="https://github.com/ollipa/meraki-client-python/actions/workflows/ci.yml">
+  <img src="https://github.com/ollipa/meraki-client-python/actions/workflows/ci.yml/badge.svg" alt="ci">
+</a>
+<a href="https://meraki-client.readthedocs.io/">
+  <img src="https://img.shields.io/readthedocs/meraki-client" alt="documentation">
+</a>
+<a href="./LICENSE">
+  <img src="https://img.shields.io/pypi/l/meraki-client" alt="license">
+</a>
+</p>
+
+<hr>
+
+<p align="center">
+<a href="https://meraki-client.readthedocs.io/">
+  <b>Documentation</b>
+</a>
+</p>
+
+<hr>
+
+Python client for the [Meraki Dashboard API](https://developer.cisco.com/meraki/api-v1/). Auto-generated from the OpenAPI spec to stay current with the latest releases.
+
+**Installation:**
+
+```shell
+pip install meraki-client
+```
+
+## Features
+
+- Modern Python 3.11+ with full type annotations
+- Sync and async clients built on httpx
+- Pydantic models for requests and responses
+- Automatic retries and pagination
+- Full API coverage ([auto-generated from OpenAPI](https://github.com/meraki/openapi))
+
+## Setup
+
+1. Enable API access in your Meraki dashboard organization and [obtain an API key](https://documentation.meraki.com/Platform_Management/Dashboard_Administration/Operate_and_Maintain/How-Tos/Cisco_Meraki_Dashboard_API)
+
+2. Pass the API key to the client, or set it as an environment variable:
+
+   ```python
+   client = MerakiClient(api_key="YOUR_KEY_HERE")
+   ```
+
+   ```shell
+   export MERAKI_DASHBOARD_API_KEY=YOUR_KEY_HERE
+   ```
+
+### Application identification
+
+Cisco Meraki recommends that ecosystem partners and application developers identify their application with API requests. See [User agents guide](https://developer.cisco.com/meraki/api-v1/user-agents-overview/#user-agents) for formatting details.
+
+```python
+client = MerakiClient(caller="ApplicationName/1.0 VendorName")
+```
+
+Or via environment variable:
+
+```shell
+export MERAKI_PYTHON_SDK_CALLER="ApplicationName/1.0 VendorName"
+```
+
+## Usage
+
+API calls follow the pattern `client.<scope>.<operation>()`, where scope maps to the OpenAPI tags (e.g., `organizations`, `networks`, `devices`).
+
+### Synchronous
+
+```python
+from meraki_client import MerakiClient
+
+client = MerakiClient()
+org = client.organizations.get_organization(org_id)
+```
+
+### Asynchronous
+
+```python
+from meraki_client.aio import AsyncMerakiClient
+
+async with AsyncMerakiClient() as client:
+    orgs = await client.organizations.get_organization(org_id)
+```
+
+## Contributing
+
+Contributions are welcome! See [CONTRIBUTING.md](https://github.com/ollipa/meraki-client-python/blob/main/CONTRIBUTING.md) for development setup, testing, and code generation instructions.
+
+## Disclaimer
+
+This is an unofficial community project, not affiliated with or endorsed by Cisco. For the official Meraki Python SDK, see [meraki/dashboard-api-python](https://github.com/meraki/dashboard-api-python). This project was forked from the official Meraki Python SDK.

meraki_client-0.1.0/bruno/Get Administered Licensing Subscription Entitlements.bru

@@ -0,0 +1,16 @@
+meta {
+  name: Get Administered Licensing Subscription Entitlements
+  type: http
+  seq: 3
+}
+
+get {
+  url: {{baseUrl}}/administered/licensing/subscription/entitlements
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

meraki_client-0.1.0/bruno/Get Network Clients.bru

@@ -0,0 +1,16 @@
+meta {
+  name: Get Network Clients
+  type: http
+  seq: 4
+}
+
+get {
+  url: {{baseUrl}}/networks/{{networkId}}/clients
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

meraki_client-0.1.0/bruno/Get Network Firmware Upgrades.bru

@@ -0,0 +1,16 @@
+meta {
+  name: Get Network Firmware Upgrades
+  type: http
+  seq: 10
+}
+
+get {
+  url: {{baseUrl}}/networks/{{networkId}}/firmwareUpgrades
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

meraki_client-0.1.0/bruno/Get Organization Appliance Dns Local Profiles.bru

@@ -0,0 +1,16 @@
+meta {
+  name: Get Organization Appliance Dns Local Profiles
+  type: http
+  seq: 1
+}
+
+get {
+  url: {{baseUrl}}/organizations/{{orgId}}/appliance/dns/local/profiles
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

meraki_client-0.1.0/bruno/Get Organization Devices.bru

@@ -0,0 +1,16 @@
+meta {
+  name: Get Organization Devices
+  type: http
+  seq: 9
+}
+
+get {
+  url: {{baseUrl}}/organizations/{{orgId}}/devices
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

meraki_client-0.1.0/bruno/Get Organization Early Access Features Opt Ins.bru

@@ -0,0 +1,16 @@
+meta {
+  name: Get Organization Early Access Features Opt Ins
+  type: http
+  seq: 6
+}
+
+get {
+  url: {{baseUrl}}/organizations/{{orgId}}/earlyAccess/features/optIns
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

meraki_client-0.1.0/bruno/Get Organization Networks.bru

@@ -0,0 +1,16 @@
+meta {
+  name: Get Organization Networks
+  type: http
+  seq: 5
+}
+
+get {
+  url: {{baseUrl}}/organizations/{{orgId}}/networks
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

meraki_client-0.1.0/bruno/Get Organization Wireless Ssids Open Roaming By Network.bru

@@ -0,0 +1,16 @@
+meta {
+  name: Get Organization Wireless Ssids Open Roaming By Network
+  type: http
+  seq: 7
+}
+
+get {
+  url: {{baseUrl}}/organizations/{{orgId}}/wireless/ssids/openRoaming/byNetwork
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}

meraki_client-0.1.0/bruno/Get Organizations.bru

@@ -0,0 +1,16 @@
+meta {
+  name: Get Organizations
+  type: http
+  seq: 8
+}
+
+get {
+  url: {{baseUrl}}/organizations
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+  timeout: 0
+}