Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
35 changes: 35 additions & 0 deletions .devcontainer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

<div align="center">
<a href="https://codespaces.new/cloudinary/account-provisioning-python.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
</div>
<br>

> **Remember to shutdown a GitHub Codespace when it is not in use!**

# Dev Containers Quick Start

The default location for usage snippets is the `samples` directory.

## Running a Usage Sample

A sample usage example has been provided in a `root.py` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.

```
python root.py
```

## Generating Additional Usage Samples

The speakeasy CLI allows you to generate more usage snippets. Here's how:

- To generate a sample for a specific operation by providing an operation ID, use:

```
speakeasy generate usage -s https://cloudinary.github.io/api-schemas/provisioning/schema.yml -l python -i {INPUT_OPERATION_ID} -o ./samples
```

- To generate samples for an entire namespace (like a tag or group name), use:

```
speakeasy generate usage -s https://cloudinary.github.io/api-schemas/provisioning/schema.yml -l python -n {INPUT_TAG_NAME} -o ./samples
```
38 changes: 38 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/images/tree/main/src/python
{
"name": "Python",
"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh",
"customizations": {
"vscode": {
"extensions": [
"ms-python.python",
"ms-python.vscode-pylance",
"github.vscode-pull-request-github"
],
"settings": {
"files.eol": "\n",
"editor.formatOnSave": true,
"python.formatting.provider": "black",
"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.linting.flake8Enabled": true,
"python.linting.banditEnabled": true,
"python.testing.pytestEnabled": true
}
},
"codespaces": {
"openFiles": [
".devcontainer/README.md"
]
}
}
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
15 changes: 15 additions & 0 deletions .devcontainer/setup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/bash

# Install the speakeasy CLI
curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh

# Setup samples directory
rmdir samples || true
mkdir samples


python -m pip install --upgrade pip
pip install -e .

# Generate starter usage sample with speakeasy
speakeasy generate usage -s https://cloudinary.github.io/api-schemas/provisioning/schema.yml -l python -o samples/root.py
32 changes: 19 additions & 13 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ management:
docVersion: 0.2.1
speakeasyVersion: 1.725.0
generationVersion: 2.836.5
releaseVersion: 0.1.0
configChecksum: e79707b0073203ae86288faef433b6cf
releaseVersion: 0.1.1
configChecksum: 46472c652c96c87545cd413451e7cbe6
repoURL: https://github.com/cloudinary/account-provisioning-python.git
installationURL: https://github.com/cloudinary/account-provisioning-python.git
persistentEdits:
generation_id: 0949abb5-dfc7-4ece-922a-7b71c8c41ed4
pristine_commit_hash: 266e71cf34dbf3243b64ba5e606d56d642d7f5dd
pristine_tree_hash: 2aab5253bd02d6d0544654f4fab49d61ddc6020e
generation_id: 523316e1-b15b-4203-be9e-5ab190c5df43
pristine_commit_hash: 0a60fd101337eeb6c629bc0fa77cd7c519e65ea4
pristine_tree_hash: 59b84db12d8ea45290c3057c2a204a3c51c65323
features:
python:
additionalDependencies: 1.0.0
Expand All @@ -37,8 +39,8 @@ features:
trackedFiles:
.devcontainer/README.md:
id: b170c0f184ac
last_write_checksum: sha1:855de42ee70c98328691f5f2f736895323a7a352
pristine_git_object: 555854e54c06c221b05c81047b4eece1f18f1f65
last_write_checksum: sha1:a64fd5632ab19b45848b8f60745abedb200090d7
pristine_git_object: cb1524f6c54a38c16c4db8fa0a60539d2319cc53
.devcontainer/devcontainer.json:
id: b34062a34eb1
last_write_checksum: sha1:fbbce5654b8990b172a9ffe841d7635cd51c495b
Expand Down Expand Up @@ -829,12 +831,16 @@ trackedFiles:
pristine_git_object: b41e83b1af81e4f783a4007869370c0d60504b45
pyproject.toml:
id: 5d07e7d72637
last_write_checksum: sha1:d8ab9afb759a8e61c3d8a519a430392977166f8c
pristine_git_object: ca7dac943ab9e7801cafc73493460f9df848d131
last_write_checksum: sha1:c9388bb13830e7947330da8987373aca23239769
pristine_git_object: 83a0cf8ef3715d4e2a0c893890943bca3621b277
scripts/prepare_readme.py:
id: e0c5957a6035
last_write_checksum: sha1:a5741d35e04ef110fcd07926f8fcfdbf7e61ffb7
pristine_git_object: 062f20a7ca52115c9ac6f2fc64fc9bf989d73d93
scripts/publish.sh:
id: fe273b08f514
last_write_checksum: sha1:11c8a74f613fdb29f432e3feafb84072eeba6428
pristine_git_object: 5eb52a49483fd30944c0a030f0decde1360f6765
last_write_checksum: sha1:b31bafc19c15ab5ea925fdf8d5d4adce2b115a63
pristine_git_object: 2a3ead70ccc6228cbae1c5c8a319b1399f3804ea
src/cloudinary_account_provisioning/__init__.py:
id: a98ea32e5e6e
last_write_checksum: sha1:36306d1d404b6aeb912d27f1d9c52f098ff7bf9b
Expand All @@ -853,8 +859,8 @@ trackedFiles:
pristine_git_object: 37dc1e0c10cef89a3c7f8218b2cb9694a4944f83
src/cloudinary_account_provisioning/_version.py:
id: 76c72d55f9f0
last_write_checksum: sha1:06b9afd3a6b34c3c6a815a55c06bc6f9260d4b5b
pristine_git_object: 698824bdb9604f7cd917c105adfadbb8f7f214e1
last_write_checksum: sha1:64496cd4562f3d2586734927583485667d054cc3
pristine_git_object: 0e9e45dc735f9393bfef0defc1915557adfcca38
src/cloudinary_account_provisioning/accesskeys.py:
id: 3d4cc397b561
last_write_checksum: sha1:595e9b632c47beea5a9b96b12e8d03ba79490005
Expand Down
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ generation:
generateNewTests: false
skipResponseBodyAssertions: false
python:
version: 0.1.0
version: 0.1.1
additionalDependencies:
dev: {}
main: {}
Expand Down
3 changes: 2 additions & 1 deletion .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sources:
sourceBlobDigest: sha256:0c58d072e0b61c934870ce292789dd513ea1df64ec9a625f3e428fc17fcf2574
tags:
- latest
- speakeasy-sdk-regen-1771901802
- 0.2.1
targets:
cloudinary:
Expand All @@ -14,7 +15,7 @@ targets:
sourceRevisionDigest: sha256:2eb14e9aa6662f5f4f1d9ef1039678b31573aebc5765ea3e64a4d2017f9073d4
sourceBlobDigest: sha256:0c58d072e0b61c934870ce292789dd513ea1df64ec9a625f3e428fc17fcf2574
codeSamplesNamespace: cloudinary-provisioning-python-code-samples
codeSamplesRevisionDigest: sha256:51b4b477a0ec7db077e23bf61c39dfa7eeebc8a1f4ba5b80e7efa092acbe803f
codeSamplesRevisionDigest: sha256:77293005f11b5f2f0f8da3247f2fcce2aa0c14f2fa2f63a8d6b1cbdddd864493
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
6 changes: 6 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"python.testing.pytestArgs": ["tests", "-vv"],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"pylint.args": ["--rcfile=pylintrc"]
}
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing to This Repository

Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.

## How to Report Issues

If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:

- A clear and descriptive title
- Steps to reproduce the issue
- Expected and actual behavior
- Any relevant logs, screenshots, or error messages
- Information about your environment (e.g., operating system, software versions)
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed

## Issue Triage and Upstream Fixes

We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.

## Contact

If you have any questions or need further assistance, please feel free to reach out by opening an issue.

Thank you for your understanding and cooperation!

The Maintainers
Loading