Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/radarsh/terminator

An extremely lightweight terminal based Jenkins build monitor
https://github.com/radarsh/terminator

build-monitor jenkins python

Last synced: 4 months ago
JSON representation

An extremely lightweight terminal based Jenkins build monitor

Host: GitHub
URL: https://github.com/radarsh/terminator
Owner: radarsh
License: apache-2.0
Created: 2015-02-01T20:59:39.000Z (about 10 years ago)
Default Branch: develop
Last Pushed: 2015-12-01T19:15:52.000Z (about 9 years ago)
Last Synced: 2023-03-22T14:42:32.514Z (almost 2 years ago)
Topics: build-monitor, jenkins, python
Language: Python
Homepage:
Size: 501 KB
Stars: 8
Watchers: 4
Forks: 4
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# terminator

An extremely lightweight terminal based Jenkins build monitor written using Python.

Terminator is designed to be run on low powered computers such as Raspberry Pi. Often it is more efficient and practical
to use a terminal based build monitor than running a full fledged browser such as Epiphany or Firefox.

#### Linux Terminal

![Screenshot of Ubuntu Terminal](docs/images/ubuntu.png)

#### Windows Command Prompt

![Screenshot of Windows Command Prompt](docs/images/windows.png)

## Prerequisites

- Python 3.2 (but 3.4 is recommended)
- Pip 3

## Installation

Install all the requirements.

```bash
$ cd terminator
$ sudo pip install -r requirements.txt
```

## Usage

Terminator is highly customisable. It supports the following modes of operation:

#### To output the default view

```python
$ python -m terminator
```

#### To output another Jenkins view

```python
$ python -m terminator -v "view_name"
```

#### To output a list of specific jobs

```python
$ python -m terminator -j "job-1 job-2 job-3"
```

#### Change the polling interval

```python
$ python -m terminator -i INTERVAL
```

Here `INTERVAL` is in seconds.

#### If your Jenkins needs authentication

```python
$ python -m terminator -u USERNAME -p
```

#### Override terminal width

```python
$ python -m terminator -w WIDTH
```

Sometimes you might want to use `tput cols` to get the terminal width.

```python
$ python -m terminator -w "$(tput cols)"
```

#### Change the default font

```python
$ python -m terminator -f FONT
```

`FONT` can be one of the [pyfiglet fonts](https://github.com/pwaller/pyfiglet/tree/master/pyfiglet/fonts). Just make
sure that the font you choose does not break your terminal width.