feat: update SDK codebase to replace Go with Python

Author: ctreatma

.github/workflows/release.yaml

@@ -5,23 +5,37 @@ name: Generate Next Release
 on:
   workflow_dispatch:
 
+env:
+  PACKAGE_DIR: equinix_metal
+  DIST_DIR: equinix_metal/dist
 jobs:
   release:
-    name: Release
+    name: Build and publish package
     runs-on: ubuntu-latest
+
     steps:
-      - name: Install Go
-        uses: actions/setup-go@v5
+      - name: Install Python
+        uses: actions/setup-python@v5
         with:
-          go-version: 1.19.x
+          python-version: 3.8
 
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ssh-key: ${{ secrets.DEPLOY_KEY }}
 
-      - name: Release
+      - name: Install dependencies
+        working-directory: ${{ env.PACKAGE_DIR }}
+        run: |
+          python -m pip install --upgrade build
+
+      - name: Install pyaml for patching script
+        working-directory: ${{ env.PACKAGE_DIR }}
+        run: |
+          python -m pip install pyaml
+
+      - name: Create GitHub release
         uses: cycjimmy/semantic-release-action@v4
         with:
           semantic_version: 19.0.5
@@ -36,3 +50,15 @@ jobs:
           GIT_COMMITTER_NAME: equinix-labs@auto-commit-workflow
           GIT_COMMITTER_EMAIL: [email protected]
           RELEASE_REQUESTER: "@${{ github.event.sender.login }}"
+
+      - name: Build package
+        working-directory: ${{ env.PACKAGE_DIR }}
+        run: |
+          python -m build --sdist --wheel --outdir dist/ .
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages-dir: ${{ env.DIST_DIR }}

.gitignore

@@ -1,7 +1,67 @@
-equinix-metal.swagger.json.orig
-.vscode
-.DS_Store
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+venv/
+.venv/
+.python-version
+.pytest_cache
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints
 .openapi-generator
-.travis.yml
-git_push.sh
-services/*/api/

.openapi-generator-ignore

@@ -0,0 +1,25 @@
+setup.py
+setup.cfg
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

CONTRIBUTING.md

@@ -2,19 +2,19 @@
   Thx for your interest! We're so glad you're here.
 
 ### Important Resources
-  - bugs: [https://github.com/equinix/equinix-sdk-go/issues](https://github.com/equinix/metal/issues)
+  - bugs: [https://github.com/equinix/equinix-sdk-python/issues](https://github.com/equinix/metal/issues)
 
 ### Code of Conduct
-Available via [https://github.com/equinix/equinix-sdk-go/blob/master/.github/CODE_OF_CONDUCT.md](https://github.com/equinix/metal/blob/master/.github/CODE_OF_CONDUCT.md)
+Available via [https://github.com/equinix/equinix-sdk-python/blob/master/.github/CODE_OF_CONDUCT.md](https://github.com/equinix/metal/blob/master/.github/CODE_OF_CONDUCT.md)
 
 ### Environment Details
-[https://github.com/equinix/equinix-sdk-go/blob/master/Makefile](https://github.com/equinix/equinix-sdk-go/blob/master/Makefile)
+[https://github.com/equinix/equinix-sdk-python/blob/master/Makefile](https://github.com/equinix/equinix-sdk-python/blob/master/Makefile)
 
 ### How to Submit Change Requests
-Please submit change requests and / or features via [Issues](https://github.com/equinix/equinix-sdk-go/issues). There's no guarantee it'll be changed, but you never know until you try. We'll try to add comments as soon as possible, though.
+Please submit change requests and / or features via [Issues](https://github.com/equinix/equinix-sdk-python/issues). There's no guarantee it'll be changed, but you never know until you try. We'll try to add comments as soon as possible, though.
 
 #### Pull Requests
 All command changes must be reflected in the documentation, this includes new commands and changes to options. The documentation is generated via `make generate-docs`.
 
 ### How to Report a Bug
-Bugs are problems in code, in the functionality of an application or in its UI design; you can submit them through [Issues](https://github.com/equinix/equinix-sdk-go/issues) as well.
+Bugs are problems in code, in the functionality of an application or in its UI design; you can submit them through [Issues](https://github.com/equinix/equinix-sdk-python/issues) as well.

DEVELOPMENT.md

@@ -8,7 +8,7 @@
 - `spec/services/<service>/oas3.patched` a directory of the latest patched OpenAPI spec for a single service
 - `spec/services/<service>/patches/*.patch` patch files to apply against the fetched OpenAPI spec for a single service
 - `examples/` hand crafted examples to demonstrate usage
-- `services/<service>` generated Go client for a single service
+- `equinix/services/<service>` generated Python client for a single service
 
 ## Build
 
@@ -32,9 +32,9 @@ The onboarding proces will automatically attempt to download the spec and genera
 
 ## Adding custom openapi-generator templates for a service
 
-This repo uses [`openapi-generator`](https://github.com/OpenAPITools/openapi-generator) to generate Go code.  When necessary, we can provide custom templates to the generator in order to change the generated code.
+This repo uses [`openapi-generator`](https://github.com/OpenAPITools/openapi-generator) to generate Python code.  When necessary, we can provide custom templates to the generator in order to change the generated code.
 
-When a service is onboarded, an empty `templates/services/<service>/` directory is created. To modify generated code, you can put a custom template in this directory.  Templates that are known to the generator can be seen here: https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/go
+When a service is onboarded, an empty `templates/services/<service>/` directory is created. To modify generated code, you can put a custom template in this directory.  Templates that are known to the generator can be seen here: https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/python
 
 Before adding custom templates for a service, review [the `openapi-generator` docs for templating](https://openapi-generator.tech/docs/templating).
 

Makefile

@@ -1,19 +1,18 @@
-.PHONY: all pull fetch patch generate clean codegen mod docs move-other patch-post fmt test stage
+.PHONY: all pull fetch patch generate clean codegen docs move-other patch-post fmt test stage
 
 CURRENT_UID := $(shell id -u)
 CURRENT_GID := $(shell id -g)
 
 GIT_ORG=equinix
-GIT_REPO=equinix-sdk-go
+GIT_REPO=equinix-sdk-python
 PACKAGE_VERSION=$(shell cat version)
 USER_AGENT=${GIT_REPO}/${PACKAGE_VERSION}
 
-OPENAPI_IMAGE_TAG=v7.1.0
+OPENAPI_IMAGE_TAG=v7.4.0
 OPENAPI_IMAGE=openapitools/openapi-generator-cli:${OPENAPI_IMAGE_TAG}
 CRI=docker # nerdctl
 OPENAPI_GENERATOR=${CRI} run --rm -u ${CURRENT_UID}:${CURRENT_GID} -v $(CURDIR):/local ${OPENAPI_IMAGE}
 SPEC_FETCHER=${CRI} run --rm -u ${CURRENT_UID}:${CURRENT_GID} -v $(CURDIR):/workdir --entrypoint sh mikefarah/yq:4.30.8 script/download_spec.sh
-GOLANGCI_LINT=golangci-lint
 
 SPEC_BASE_DIR=spec/services
 TEMPLATE_BASE_DIR=templates/services
@@ -27,19 +26,5 @@ generate-all:
 		make -f $$makefile generate;\
 	done
 
-mod:
-	rm -f go.mod go.sum ${PACKAGE_PREFIX}/${PACKAGE_MAJOR}/go.mod ${PACKAGE_PREFIX}/${PACKAGE_MAJOR}/go.sum
-	go mod init github.com/${GIT_ORG}/${GIT_REPO}
-	go mod tidy
-
-test:
-	go test -v ./...
-
-lint:
-	@$(GOLANGCI_LINT) run -v --no-config --fast=false --fix --disable-all --enable goimports $(PACKAGE_PREFIX)
-
-fmt:
-	go run mvdan.cc/[email protected] -l -w .
-
 stage:
 	test -d .git && git add --intent-to-add .

README.md

@@ -1,25 +1,33 @@
-# Equinix Go SDK
+# Equinix Python SDK
 
 [![Maintained](https://img.shields.io/badge/stability-maintained-green.svg)](https://github.com/equinix-labs/equinix-labs/blob/main/maintained-statement.md)
+[![Release](https://img.shields.io/github/v/release/equinix/equinix-sdk-python)](https://github.com/equinix/equinix-sdk-python/releases/latest)
+[![PyPi](https://img.shields.io/pypi/v/equinix-sdk-python)](https://img.shields.io/pypi/v/equinix-sdk-python)
 
-This is the official Go SDK for Equinix services.  This SDK is currently provided with a major version of [v0](https://blog.golang.org/v2-go-modules). We aim to avoid breaking changes to this library, but they will certainly happen as we work towards a stable v1 library.
+This is the official Python SDK for Equinix services.  This SDK is currently provided with a major version of `v0`. We aim to avoid breaking changes to this library, but they will certainly happen as we work towards a stable `v1` library.
 
-Each Equinix service supported by this SDK is maintained as a separate package that is generated from the OpenAPI specification for that service.  If any Equinix service is not supported by this SDK and you would like to see it added, please [submit a change request](CONTRIBUTING.md)
+Each Equinix service supported by this SDK is maintained as a separate submodule that is generated from the OpenAPI specification for that service.  If any Equinix service is not supported by this SDK and you would like to see it added, please [submit a change request](CONTRIBUTING.md)
 
 ## Installation
 
-To import this library into your Go project:
+To import this library into your Python project:
 
-```go
-import "github.com/equinix/equinix-sdk-go"
+```sh
+pip install equinix
 ```
 
-Download the module with:
+In a given Python file, you can then import all available services: 
 
-```sh
-go get github.com/equinix/equinix-sdk-go
+```python
+import equinix
+```
+
+Or you can import individual services:
+
+```python
+from equinix.services import metalv1
 ```
 
 ## Usage
 
-You can see usage of the generated code in the [`examples` directory](https://github.com/equinix/equinix-sdk-go/tree/main/examples).
+You can see usage of the generated code in the [`examples` directory](https://github.com/equinix/equinix-sdk-python/tree/main/examples).

config/openapi-generator.json

@@ -1,9 +1,7 @@
 {
-    "apiNameSuffix": "Api",
-    "isGoSubmodule": true,
+    "generateSourceCodeOnly": true,
     "disallowAdditionalPropertiesIfNotPresent": false,
     "inlineSchemaOptions": {
         "RESOLVE_INLINE_ENUMS": true
-    },
-    "enumClassPrefix": true
+    }
 }