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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
- [Overview](#overview)
- [Reader Prerequisites](#reader-prerequisites)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Installation Instructions](#installation-instructions)
- [Using PIP](#using-pip)
- [For development](#for-development)
- [Usage](#usage)
- [Quickstart](#quickstart)
- [Selectors](#selectors)
Expand Down Expand Up @@ -59,15 +63,18 @@ the CLI documentation to find the pass-through arguments a given interaction req
* A familiarity with Python is assumed.

## Setup
Setup-Prerequisites
1. You will require certain pip packages, use the following command to install them when at the root folder of the repository.
### Prerequisites
1. Download and install the OpenShift [command-line Tools](https://mirror.openshift.com/pub/openshift-v4/clients/ocp/latest/) needed to access your OpenShift cluster.

### Installation Instructions

#### Using PIP
1. Install the `openshift-client` module from PyPI.
```bash
sudo pip install -r requirements.txt
sudo pip install openshift-client
```
2. Download and install the OpenShift [command-line Tools](https://mirror.openshift.com/pub/openshift-v4/clients/ocp/latest/) needed to access your OpenShift cluster.

Setup steps
#### For development
1. Git clone https://github.com/openshift/openshift-client-python.git (or your fork).
2. Append ./packages to your PYTHONPATH environment variable (e.g. export PYTHONPATH=$(pwd)/packages:$PYTHONPATH).
3. Write and run your python script!
Expand Down
2 changes: 1 addition & 1 deletion ansible/rebuild_module.digest
Original file line number Diff line number Diff line change
@@ -1 +1 @@
5989e72fd25bf177445364381d4ad2dd -
4008d9385ab44dc3856603d9fb96eaef -

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions docs/PACKAGING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Openshift Python Client Packaging](#openshift-python-client-packaging)
- [Introduction](#introduction)
- [Recommended Setup](#recommended-setup)
- [Create User Accounts](#create-user-accounts)
- [PyPI - The Python Package Index](#pypi---the-python-package-index)
- [TestPyPI - The Test Python Package Index](#testpypi---the-test-python-package-index)
- [Generate API Tokens](#generate-api-tokens)
- [setup.cfg](#setupcfg)
- [Building](#building)
- [Publishing](#publishing)
- [TestPyPI](#testpypi)
- [PyPI](#pypi)
- [Installation](#installation)
- [TestPyPI](#testpypi-1)
- [PyPI](#pypi-1)
- [Cleanup](#cleanup)
- [Helpful Links](#helpful-links)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Openshift Python Client Packaging

## Introduction
Expand Down
2 changes: 1 addition & 1 deletion packages/openshift/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from .ansible import ansible

# Single source for module version
__VERSION__ = '1.0.2'
__VERSION__ = '1.0.3'

null = None # Allow scripts to specify null in object definitions

Expand Down