# python-cfconfigurator
`python-cfconfigurator` is a simple and small library to manage Cloud Foundry
common operations (not aimed to manage apps or service brokers). The idea
behind this implementation is having a library to be used for Configuration
Management tools, in particular for
[Ansible modules](https://github.com/SpringerPE/ansible-modules-cloudfoundry).
CF class implements support to manage: users, blobstore cache, environment
variable groups, feature flags, shared domains, private domains, organizations,
quotas, spaces, security groups and security group rules.
There is also a UAA implementation which adds support to manage users,
groups and clients directly with an UAA server.
Code compatible with Python 2 and Python 3
Documentation of the APIs used:
* https://apidocs.cloudfoundry.org
* https://docs.cloudfoundry.org/api/uaa
## Example
Install via pip: `pip install cfconfigurator`
```
from cfconfigurator.cf import CF
api_url = "https://api.test.cf.example.com"
admin_user = "admin"
admin_password = "admin"
cf = CF(api_url)
cf.login(admin_user, admin_password)
org = cf.search_org("pivotal")
print(org)
```
## Upload to PyPI
1. Create a `.pypirc` configuration file. This file holds your information for authenticating with PyPI.
```
[distutils]
index-servers = pypi
[pypi]
repository=https://pypi.python.org/pypi
username=your_username
password=your_password
```
2. Login and upload it to PyPI
```
python setup.py register -r pypi
python setup.py sdist upload -r pypi
```
## TODO
* Tests, tests ... fix me!
* Buildpack management
## Author
Springer Nature Platform Engineering, Jose Riguera Lopez (jose.riguera@springer.com)
Copyright 2017 Springer Nature
`python-cfconfigurator` is a simple and small library to manage Cloud Foundry
common operations (not aimed to manage apps or service brokers). The idea
behind this implementation is having a library to be used for Configuration
Management tools, in particular for
[Ansible modules](https://github.com/SpringerPE/ansible-modules-cloudfoundry).
CF class implements support to manage: users, blobstore cache, environment
variable groups, feature flags, shared domains, private domains, organizations,
quotas, spaces, security groups and security group rules.
There is also a UAA implementation which adds support to manage users,
groups and clients directly with an UAA server.
Code compatible with Python 2 and Python 3
Documentation of the APIs used:
* https://apidocs.cloudfoundry.org
* https://docs.cloudfoundry.org/api/uaa
## Example
Install via pip: `pip install cfconfigurator`
```
from cfconfigurator.cf import CF
api_url = "https://api.test.cf.example.com"
admin_user = "admin"
admin_password = "admin"
cf = CF(api_url)
cf.login(admin_user, admin_password)
org = cf.search_org("pivotal")
print(org)
```
## Upload to PyPI
1. Create a `.pypirc` configuration file. This file holds your information for authenticating with PyPI.
```
[distutils]
index-servers = pypi
[pypi]
repository=https://pypi.python.org/pypi
username=your_username
password=your_password
```
2. Login and upload it to PyPI
```
python setup.py register -r pypi
python setup.py sdist upload -r pypi
```
## TODO
* Tests, tests ... fix me!
* Buildpack management
## Author
Springer Nature Platform Engineering, Jose Riguera Lopez (jose.riguera@springer.com)
Copyright 2017 Springer Nature
Release files for cfconfigurator 0.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cfconfigurator-0.2.3.tar.gz | 11.1 kB | Details |
Release files / cfconfigurator-0.2.3.tar.gz
| Download URL | cfconfigurator-0.2.3.tar.gz |
|---|---|
| Size | 11.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d81a09c98752e8682b583b87e4d737bc7478c468bf7ee832b50522b974a5c09c
|
|
BLAKE2b-256 checksum How to use checksums |
2e4a45ac771c540326a1385a4acdce6ba1805ceab52179705559d13ce91355aa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |