Skip to content

Latest commit

 

History

History
85 lines (53 loc) · 2.08 KB

README.md

File metadata and controls

85 lines (53 loc) · 2.08 KB
Raw

jenkins-tui 📦

jenkins-tui PyPI version

jenkins-tui is a terminal based user interface for Jenkins.

🚧 ⚠️ This app is a prototype and in very early stages of development. There will be bugs and missing functionality. Additionally, it has only been tested on OSX.

🚀 This project is powered by textual and rich!

Installing with pip

pip install jenkins-tui

Configure

The app stores the sensitive stuff at ~/.jenkins-tui.toml. You can create it manually using the schema below or let the app do it for you on first run.

# .jenkins-tui.toml

url = ""
username = ""
password = ""

Run

jenkins

Develop

Install dependencies

Install dependencies with poetry:

poetry install

Building

To keep local builds consistent with ci, use make to build and lint:

make build

Install pre commit hooks

The project uses pre-commit for commit time checking. You can find the configuration here.

pre-commit install

Releasing stuff

Releasing is a semi manual but well oiled method. Tags are used to trigger the release steps in the ci process.

Running the following make command will tag and push the latest commit triggering a release.

make tag version="v0.0.5"

Note: Releases can only be generated from the main branch.

Runing locally

You can either build a new package using make build and install it or run the package directly:

cd src
python -m jenkins_tui.app

Compatibility

This project has been tested on macOS and Linux (Arch, Ubuntu 20.04 and above) with Python 3.9 installed. It will likely work on any Linux distribution where Python 3.9 or above is available. For Ubuntu 20.04, it may be necessary to install the python3.9 package.