#884: Cleanup examples folder

[scottilee]

• Added README
• Added descriptions
• Renamed files to consistent format (generally ..py)
• Removes examples that are basically duplicates
• Some minor refactoring

Fixes#884

[micw523]

I didn’t get through all of it, but some of the changes introduced here do warrant more discussion / more carefully thought over. Also, large PRs can be very hard to review.

[micw523]

Why is this first sentence needed?

[scottilee]

Not sure what you're asking? Let me know if you'd prefer something else.

[micw523]

CI is failing - please address the code style suggestions by the CI

[scottilee]

@micw523 I fixed all the code style suggestions related to the files touched in this PR but there's additional ones about unrelated files.

/home/travis/build/kubernetes-client/python/kubernetes/config/kube_config_test.py:1375:80: E501 line too long (96 > 79 characters)
/home/travis/build/kubernetes-client/python/kubernetes/watch/watch_test.py:81:80: E501 line too long (86 > 79 characters)
/home/travis/build/kubernetes-client/python/kubernetes/utils/quantity.py:24:80: E501 line too long (91 > 79 characters)

[micw523]

E501 errors are non-blocking; the problems are in pod_namespace_watch.py, examples/pod_exec.py, pod_config_list.py, examples/custom_object.py. Try using autopep8 with aggressive level 2 on those files.

[micw523]

The create_deployment.py file is renamed to deployment_create_yaml.py. I prefer the previous name b/c this file is not using the create_from_yaml utlity but calling the API directly.

[micw523]

This is a little different from the create_deployment file since it is also using rollback and rollingupdate.

[scottilee]

Restored. I also changed deployment_create_yaml.py to deployment_create.py

[roycaihw]

Are these ipynb file auto-generated? Do they affect the document website? @micw523

[micw523]

This one is not automatically generated and was written by someone a long time ago. However, I believe this one is a little out of date for using beta API (?).

[scottilee]

Renamed files:

examples/create_deployment.py → examples/deployment_create.py
examples/deployment_examples.py → examples/deployment_crud.py
examples/example1.py → examples/in_cluster_config.py
examples/example2.py → examples/pod_namespace_watch.py
examples/example3.py → examples/api_discovery.py
examples/exec.py → examples/pod_exec.py
examples/ingress-example.py → examples/ingress_create.py
examples/job_examples.py → examples/job_crud.py
examples/manage_node_labels.py → examples/node_labels.py

[roycaihw]

examples/example1.py → examples/in_cluster_config.py

example1 and in_cluster_config are under different assumptions and use different config loading methods. Could you keep both of them and rename example1 to out_of_cluster_config (similar to what client-go has)?

[scottilee]

@roycaihw done, and I rebased.

[roycaihw]

One major questions about unexpected example content being changed (oversight during copy-pasting?): #938 (comment). Otherwise looks pretty good. Thanks @scottilee!

/approve

@micw523 has lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: roycaihw, scottilee

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [roycaihw]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[micw523]

Yeah, lgtm to me as long as the last round of comments are addressed.

[micw523]

/lgtm
Since there are only two commits I’m gonna lgtm this