Skip to content

keshavdv/marathon-python

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

marathon-python

Build Status

This is a Python library for interfacing with Marathon servers via Marathon's REST API.

Compatibility

marathon-python is primarily developed against Marathon 0.8.x (see Marathon docs)

  • For Marathon 0.8.x-0.9.x, use the latest release
  • For Marathon 0.7.x, use marathon-python 0.6.10
  • For older versions, please see CHANGELOG.md

Installation

From PyPi (recommended)

pip install marathon

From GitHub

pip install -e git+git@github.com:thefactory/marathon-python.git#egg=marathon

From source

git clone git@github.com:thefactory/marathon-python
python marathon-python/setup.py install

Testing

To run integration tests included you need to configure tests/config.py and specify the MARATHON_SERVER variable to point at your Marathon server. The integration test also assumes that you have your Mesos/Marathon cluster configured to work with Docker. See Running Docker Containers on Marathon for more info.

Running The Tests

    cd marathon-python
    python -m unittest discover -v

Documentation

API documentation is here.

Or you can build the documentation yourself:

pip install sphinx
pip install sphinx_rtd_theme
cd docs/
make html

The documentation will be in <project-root>/gh-pages/html:

open gh-pages/html/index.html

Basic Usage

Create a MarathonClient() instance pointing at your Marathon server(s):

>>> from marathon import MarathonClient
>>> c = MarathonClient('http://localhost:8080')

>>> # or multiple servers:
>>> c = MarathonClient(['http://host1:8080', 'http://host2:8080'])

Then try calling some methods:

>>> c.list_apps()
[MarathonApp::myapp1, MarathonApp::myapp2]
>>> from marathon.models import MarathonApp
>>> c.create_app('myapp3', MarathonApp(cmd='sleep 100', mem=16, cpus=1))
MarathonApp::myapp3
>>> app = c.get_app('myapp3')
>>> app.ports
[19671]
>>> app.mem = 32
>>> c.update_app('myapp3', app)
{'deploymentId': '83b215a6-4e26-4e44-9333-5c385eda6438', 'version': '2014-08-26T07:37:50.462Z'}
>>> c.get_app('myapp3').mem
32.0
>>> c.get_app('myapp3').instances
1
>>> c.scale_app('myapp3', 2)
{'deploymentId': '611b89e3-99f2-4d8a-afe1-ec0b83fdbb88', 'version': '2014-08-26T07:40:20.121Z'}
>>> c.get_app('myapp3').instances
3
>>> c.scale_app('myapp3', delta=-1)
{'deploymentId': '1081a99c-55e8-4404-907b-4a3697059848', 'version': '2014-08-26T07:43:30.232Z'}
>>> c.get_app('myapp3').instances
2
>>> c.list_tasks('myapp1')
[MarathonTask:myapp1-1398201790254]
>>> c.kill_tasks('myapp1', scale=True)
[MarathonTask:myapp1-1398201790254]
>>> c.list_tasks('myapp1')
[]

License

Open source under the MIT License. See LICENSE.

About

Python client library for Mesos Marathon's REST API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 98.3%
  • Other 1.7%