https://github.com/e2fyi/argo-models

Generated openapi models for argo
https://github.com/e2fyi/argo-models

argo kubeflow openapi python swagger

Last synced: about 2 hours ago
JSON representation

Generated openapi models for argo

• Host: GitHub
• URL: https://github.com/e2fyi/argo-models
• Owner: e2fyi
• License: apache-2.0
• Created: 2019-05-04T10:42:20.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-05-11T13:19:27.000Z (over 4 years ago)
• Last Synced: 2024-08-31T18:45:54.518Z (3 months ago)
• Topics: argo, kubeflow, openapi, python, swagger
• Language: Python
• Homepage:
• Size: 1010 KB
• Stars: 8
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# argo-models

[![Build Status](https://travis-ci.org/e2fyi/argo-models.svg?branch=master)](https://travis-ci.org/e2fyi/argo-models)

[![PyPI version](https://badge.fury.io/py/argo-models.svg)](https://badge.fury.io/py/argo-models)

[![Downloads](https://pepy.tech/badge/argo-models/month)](https://pepy.tech/project/argo-models/month)

`argo-models` is a `argo` namespaced package with the `argo.models` subpackage

which contains the generated OpenAPI models from [Argo](https://github.com/argoproj/argo).

Documentations can be found at https://argo-models.readthedocs.io/en/latest/

```bash

pip install argo-models

```

```py

from argo.models import V1alpha1ArtifactLocation, V1alpha1S3Artifact

from kubernetes.client.models import V1SecretKeySelector

# create aws cred

access_key_secret = V1SecretKeySelector(name="s3_secret", key="accesskey")

secret_key_secret = V1SecretKeySelector(name="s3_secret", key="secretkey")

# create artifact config for s3

s3_artifact = V1alpha1S3Artifact(

    bucket="foobar",

    endpoint="s3.amazonaws.com"

    insecure=False,

    access_key_secret=access_key_secret,

    secret_key_secret=secret_key_secret,

    key=""

)

# create artifact location

artifact_location = V1alpha1ArtifactLocation(s3=s3_artifact)

```

## Developer notes

To generate the latest models, update `version.txt` with the desired argo release

(e.g. `2.3.0-rc3`) and then run `./generate-api.sh`.

To release new version to pypi, create a release with the corresponding version tag (e.g. `v2.2.1`). Travis will automatically publish the package.

> NOTE:

>

> `version.txt` should hold the current/latest argo version to be generated, as it

> is also used by `setup.py` as the `argo-models` package version.

>

> Please install [@openapitools/openapi-generator-cli](https://www.npmjs.com/package/@openapitools/openapi-generator-cli) to

> generate the openapi specs.

## License

This package is licensed under [Apache-2.0](./LICENSE) and is a derivative of the [Argo project](https://github.com/argoproj/argo) using [OpenAPI generator](https://github.com/OpenAPITools/openapi-generator).