Skip to main content

Python Boilerplate contains all the boilerplate you need to create a Python package.

Project description

# Xserverpy

[![Build Status](]( [![Coverage Status](](
[![PyPI version](](

Xserverpy makes it possible to use Xcode bots from the command line.


# Use cases
- Running Xcode server tasks, like new integration (ie. Build project) or list bots, without the need to install or run Xcode.
- Build Xcode bots from another CI tool like Jenkins (see [Future milestones and improvements](#future-milestones-and-improvements).
- You love ASCII progress bars (or Nikola Tesla's inventions)

# Installation

## Using brew (recommended)
brew tap oarrabi/tap
brew install xserverpy

## Using pip
pip install xserverpy

# Usage

## Authentication and Host information
All of xserverpy command accept authentication and Xcode server host/port as flags. For example, in order to list all the bots you would run:

xserverpy bots --host HOST --port PORT --user USER --pass PASS

To reduce duplication in calling consequent or future commands, you can run `init` subcommand to store these configuration on your machine.

xserverpy init --host HOST --port PORT --user USER --pass PASS

Now that you stored them, you can call all of xcserverpy subcommands without passing these stored arguments:

xserverpy bots
xserverpy integrations list

xserverpy init flags:

--host HOST Xcode server host
--port PORT Xcode server host port, default 443
--user USER Username to use for authentication
--password PASSWORD Password to use for authentication
--local Store configuration file in the local directory

- Running `init` sotres a configuration file at `~/.xserverpy`.
- Using `init --local` stores the configuration in the current directory

## Bots
List all bots [Demo](

xserverpy bots # pass host/user info or load from stored

## Integrations
List integrations per bot [Demo](

xserverpy integrations list --bot <Bot name or ID>
Integrate (build project) [Demo](

xserverpy integrations new --bot <Bot name or ID>
Integrate and wait [Demo](

xserverpy integrations new --bot <Bot name or ID> --wait
Show running integrations [Demo](

xserverpy integrations running
Cancel integrations (build project) [Demo](

xserverpy integrations cancel --id <Integration ID>

## Note on integrate and wait
When using `xserverpy integrations new --wait`, xserverpy keeps polling Xcode server for updates on the running integrations. The default interval is .5s, you can control the behavior and the format of the progress using the following flags:

--interval INTERVAL Interval to poll the server for updates, default .5s
--no-tty Force non tty progress reporting

# Future milestones and improvements
- Create Jenkins plugin to embed Xcode server tasks in Jenkins
- Implement show all pending integrations
- Improve code coverage

# Author
Omar Abdelhafith
[nsomar](, [nsomar medium](, [@ifnottrue](

Project details

Release history Release notifications

This version
History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
xserverpy-0.2.2-py2.py3-none-any.whl (14.3 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jul 27, 2015
xserverpy-0.2.2.tar.gz (48.5 kB) Copy SHA256 hash SHA256 Source None Jul 27, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page