Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nosmoht/python-foreman

Python Class to communicate with Foreman via API v2
https://github.com/nosmoht/python-foreman

Last synced: 21 days ago
JSON representation

Python Class to communicate with Foreman via API v2

Awesome Lists containing this project

README

        

[![Build Status](https://travis-ci.org/Nosmoht/python-foreman.png)](https://travis-ci.org/Nosmoht/python-foreman)
[![Coverage Status](https://coveralls.io/repos/Nosmoht/python-foreman/badge.svg)](https://coveralls.io/r/Nosmoht/python-foreman)
# python-foreman
Python Class to communicate with Foreman via [API] v2.

The use case behind this Class is to configure Foreman with Python. The class can be easily used in an Ansible module
so the complete infrastructure can be deployed with Ansible like done in my [Ansible Library].

# Documentation
Will come soon. See the example inside the bin directory.

# Requirements
[Python-requests] is required but will be installed by setup.py.

# Installation
To install the latest version with pip from Github:
```
pip install git+https://github.com/Nosmoht/python-foreman.git#master
```

To install with python (sudo could be required):
```
git clone https://github.com/Nosmoht/python-foreman.git
cd python-foreman
python setup.py install
```

# How to use

See the backup for examples.

```
cd bin
$ ./backup_foreman.py -f foreman.example.com -p 443 -u admin -s p4ssw0rd
```

# License

BSD

# Author
[Thomas Krahn]

[API]: www.theforeman.org/api_v2.html
[Ansible Library]: https://github.com/Nosmoht/ansible-library-foreman
[Thomas Krahn]: mailto:[email protected]
[Python-requests]: https://github.com/kennethreitz/requests