Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DeepSpace2/powerline-travis-ci
A Powerline segment for fetching and showing the latest travis-ci build state
https://github.com/DeepSpace2/powerline-travis-ci
cli powerline segment shell terminal travis travis-ci
Last synced: 15 days ago
JSON representation
A Powerline segment for fetching and showing the latest travis-ci build state
- Host: GitHub
- URL: https://github.com/DeepSpace2/powerline-travis-ci
- Owner: DeepSpace2
- License: mit
- Created: 2020-11-06T16:21:30.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-06T16:27:51.000Z (about 4 years ago)
- Last Synced: 2024-09-26T07:48:40.828Z (about 2 months ago)
- Topics: cli, powerline, segment, shell, terminal, travis, travis-ci
- Language: Python
- Homepage:
- Size: 9.77 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.org/project/powerline-travis-ci/)
[](http://pepy.tech/count/powerline-travis-ci)
# powerline-travis-ci
A light-hearted [Powerline](https://github.com/powerline/powerline) segment for fetching and showing the status
of the last build on travis. The segment will only be shown if the current directory contains a `.travis.yml` file.
**Keep in mind that powerline-travis-ci is in early, rapid development stage so its API/configuration format may change.**
- [Requirements](#requirements)
- [Installation](#installation)
- [Activation](#activation)
- [Configuration and Customization](#configuration-and-customization)
- [Examples](#examples)
- [Changelog](#changelog)
## Requirements
- [Powerline](https://github.com/powerline/powerline)
- A [travis-ci.com](https://travis-ci.com) API token
## Installation
```
pip install powerline-travis-ci
```
## Activation
The very minimum required to activate the segment is to add the following to your theme JSON:
```json
{
"function": "powerline_travis_ci.latest_build_state",
"args": {
"token": API_TOKEN,
"username": TRAVIS_USERNAME
}
}
```
and the following to your colorscheme JSON (the colors can be customized):
```json
"groups": {
"latest_travis_build_state": {
"fg": "gray9",
"bg": "gray2",
"attrs": []
}
}
```
## Configuration and Customization
The following optional `args` are available:
| Argument | Type | Description | Default
| --- | --- | --- | --- |
| `canceled_text` | string | Text or icon to show for the `canceled` state | `"Canceled"` |
| `created_text` | string | Text or icon to show for the `created` state | `"Created"` |
| `errored_text` | string | Text or icon to show for the `errored` state | `"Errored"` |
| `failed_text` | string | Text or icon to show for the `failed` state | `"Failed"` |
| `for_current_branch` | boolean | If `true` the state shown is the state of the latest build of the checked out git branch | `false` |
| `git_path` | string | Only used if `for_current_branch` is `true` | `"git"` |
| `passed_text` | string | Text or icon to show for the `passed` state | `"Passed"` |
| `post_state_text` | string | Text or icon to append the state.
If contains `` a clickable link to travis will be shown (if the supported by your terminal) | `""` |
| `pre_state_text` | string | Text or icon to prepend before the state.
If contains `` a clickable link to travis will be shown (if the supported by your terminal) | `""` |
| `received_text` | string | Text or icon to show for the `received` state | `"Received"` |
| `show_state_branch` | boolean | If `true` the name of the git branch will be shown along the state | `false` |
| `started_text` | string | Text or icon to show for the `started` state | `"Started"` |
### Highlight Groups
In addition to the generic `latest_travis_build_state` group, each state can be customized independently with highlight group `latest_travis_build_state_{state}`.
For example,
```json
"latest_travis_build_state_passed": {
"fg": "white",
"bg": "darkestgreen",
"attrs": []
}
```
If a specific state does not have a highlight group then the style of `"latest_travis_build_state"` group will be used.
## Examples
##### Default configuration
##### Customized text and highlight groups for "passed" and "failed" states
```json
{
"function": "powerline_travis_ci.latest_build_state",
"args": {
"token": API_TOKEN,
"username": TRAVIS_USERNAME,
"passed_text": "✔",
"failed_text": "❌",
"pre_state_text": "Travis: "
}
}
```
```json
"latest_travis_build_state": {
"fg": "white",
"bg": "gray2",
"attrs": []
},
"latest_travis_build_state_passed": {
"fg": "white",
"bg": "darkestgreen",
"attrs": []
},
"latest_travis_build_state_failed": {
"fg": "white",
"bg": "darkestred",
"attrs": []
}
```
## Changelog
### 0.1 - Nov. 6 2020
Initial release