Skip to content

Commit

Permalink
Refactor : Rename Bloxone Python Client to Universal DDI Client (#18)
Browse files Browse the repository at this point in the history
* removed bloxone_python_client occurences

* modified all objects

* updated env variables
  • Loading branch information
unasra authored Jan 28, 2025
1 parent 33c8db5 commit fa5aec0
Show file tree
Hide file tree
Showing 888 changed files with 3,196 additions and 3,054 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: bloxone_python_client Python package
name: universal_ddi_python_client Python package

on: [push, pull_request]

Expand Down
66 changes: 33 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
# Bloxone Python Client
# Universal DDI Python Client

This repository provides a Python Client library for interacting with Infoblox BloxOne APIs. The library is generated using the [OpenAPI Generator](https://openapi-generator.tech) project.
This repository provides a Python Client library for interacting with Infoblox APIs. The library is generated using the [OpenAPI Generator](https://openapi-generator.tech) project.

The following Bloxone APIs are supported:
The following Infoblox APIs are supported:

## Bloxone Cloud
- [Infrastructure Management](infra_mgmt/README.md)
- [Infrastructure Provision (HostActivation API)](infra_provision/README.md)
- [Anycast Configuration Manager](anycast/README.md)
## Infoblox Cloud
- [Infrastructure Management](src/infra_mgmt/README.md)
- [Infrastructure Provision (HostActivation API)](src/infra_provision/README.md)
- [Anycast Configuration Manager](src/anycast/README.md)
- [Upgrade Policy](upgradePolicy/README.md)

## Bloxone Threat Defense
- [Threat Defense Cloud (FW API)](fw/README.md)
- [DNS Forwarding Proxy (DFP API)](dfp/README.md)
- [Redirect](redirect/README.md)
## Infoblox Threat Defense
- [Threat Defense Cloud (FW API)](src/fw/README.md)
- [DNS Forwarding Proxy (DFP API)](src/dfp/README.md)
- [Redirect](src/redirect/README.md)

## Universal DDI
- [IP Address Management](ipam/README.md)
- [DNS Configuration](dns_config/README.md)
- [DNS Data](dns_data/README.md)
- [Keys](keys/README.md)
- [Cloud Discovery Providers](cloud_discovery/README.md)
- [IPAM Federation](ipam_federation/README.md)
- [IP Address Management](src/ipam/README.md)
- [DNS Configuration](src/dns_config/README.md)
- [DNS Data](src/dns_data/README.md)
- [Keys](src/keys/README.md)
- [Cloud Discovery Providers](src/cloud_discovery/README.md)
- [IPAM Federation](src/ipam_federation/README.md)

## Installation

To install the Bloxone Python Client, use the following command:
To install the Universal DDI Python Client, use the following command:

```bash
pip install git+https://github.com/infobloxopen/bloxone-python-client
pip install git+https://github.com/infobloxopen/universal-ddi-python-client
```

## Usage


To use the Bloxone Python Client, you need to import the client and create an instance of the client. For example:
To use the Universal DDI Python Client, you need to import the client and create an instance of the client. For example:

```python
from bloxone_client import ApiClient
from universal_ddi_client import ApiClient

client = ApiClient()
```

Additionally , you can also add a custom config to the client. For example:

```python
from bloxone_client import Configuration, ApiClient
from universal_ddi_client import Configuration, ApiClient

config = Configuration()

Expand All @@ -64,10 +64,10 @@ view_api = ViewApi(client)

### Client Name

The client name is used to identify the client in the logs. By default, the client name is set to `bloxone-python-client`. You can change this by creating an instance of Configuration and setting the client name. For example:
The client name is used to identify the client in the logs. By default, the client name is set to `universal-ddi-python-client`. You can change this by creating an instance of Configuration and setting the client name. For example:

```python
from bloxone_client import Configuration
from universal_ddi_client import Configuration

config = Configuration(
client_name = "my-client",
Expand All @@ -79,41 +79,41 @@ config = Configuration(
The default URL for the Cloud Services Portal is `https://csp.infoblox.com`. If you need to change this, you can create an instance of Configuration and set the URL. For example:

```python
from bloxone_client import Configuration
from universal_ddi_client import Configuration

config = Configuration(
csp_url = "https://csp.eu.infoblox.com",
)
```

You can also set the URL using the environment variable `BLOXONE_CSP_URL`
You can also set the URL using the environment variable `INFOBLOX_PORTAL_URL`

### Authorization

An API key is required to access BloxOne API. You can obtain an API key by following the instructions in the guide for [Configuring User API Keys](https://docs.infoblox.com/space/BloxOneCloud/35430405/Configuring+User+API+Keys).
An API key is required to access Infoblox API. You can obtain an API key by following the instructions in the guide for [Configuring User API Keys](https://docs.infoblox.com/space/BloxOneCloud/35430405/Configuring+User+API+Keys).

To use an API key with BloxOne API, you can create a new instance of Configuration . For example:
To use an API key with Infoblox API, you can create a new instance of Configuration . For example:

```python
from bloxone_client import Configuration
from universal_ddi_client import Configuration

config = Configuration(
api_key = "API_KEY",
)
```

Alternatively, You can also set the API key using the environment variable `BLOXONE_API_KEY`
Alternatively, You can also set the API key using the environment variable `INFOBLOX_PORTAL_KEY`

Note: The API key is a secret and should be handled securely. Hardcoding the API key in your code is not recommended.

### Default Tags

The BloxOne API supports tagging resources. You can set default tags for all resources created using the client.
The Infoblox API supports tagging resources. You can set default tags for all resources created using the client.

To set the Default Tags , you can create a new instance of Configuration to set the tags. For example:

```python
from bloxone_client import Configuration
from universal_ddi_client import Configuration

config = Configuration(
default_tags = {
Expand All @@ -125,4 +125,4 @@ config = Configuration(

## Support

For support and inquiries, contact Infoblox Support or refer to the official [BloxOne documentation](https://csp.infoblox.com/apidoc).
For support and inquiries, contact Infoblox Support or refer to the official [Universal DDI documentation](https://csp.infoblox.com/apidoc).
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[tool.poetry]
name = "bloxone_python_client"
name = "universal_ddi_python_client"
version = "0.1.0"
description = "Python Client for Infoblox BloxOne API"
description = "Python Client for Infoblox Universal DDI APIs"
authors = ["Infoblox"]
license = "Apache-2.0"
readme = "README.md"
repository = "https://github.com/infobloxopen/bloxone-python-client"
keywords = ["Infoblox", "BloxOne", "OpenAPI-Generator"]
repository = "https://github.com/infobloxopen/universal-ddi-python-client"
keywords = ["Infoblox", "Universal", "DDI", "OpenAPI-Generator"]

[tool.poetry.dependencies]
python = "^3.7"
Expand Down
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#
# prerequisite: setuptools
# http://pypi.python.org/pypi/setuptools
NAME = "bloxone-python-client"
NAME = "universal-ddi-python-client"
VERSION = "0.1.0"
PYTHON_REQUIRES = ">=3.7"
REQUIRES = [
Expand All @@ -23,10 +23,10 @@
setup(
name=NAME,
version=VERSION,
description="Python client for the BloxOne API",
description="Python client for the Universal DDI APIs",
author="Infoblox",
url="https://github.com/infobloxopen/bloxone-python-client",
keywords=["Infoblox", "BloxOne", "OpenAPI-Generator"],
url="https://github.com/infobloxopen/universal-ddi-python-client",
keywords = ["Infoblox", "Universal", "DDI", "OpenAPI-Generator"],
install_requires=REQUIRES,
packages=find_packages('src', exclude=["test", "tests"]),
package_dir={'': 'src'},
Expand Down
Loading

0 comments on commit fa5aec0

Please sign in to comment.