Skip to main content

Have a quick look at the status of CI projects from the command line.

Project description

quickCI

https://img.shields.io/pypi/v/quickci.svg Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. https://travis-ci.com/robertopreste/quickCI.svg?branch=master Documentation Status https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg

Have a quick look at the status of CI projects from the command line.

Features

quickCI allows to have a quick overview of the status of build jobs on several CI services, for a specific branch of the repository being built. Currently, quickCI supports checking build status for the following CI services:

More services to come!

Usage

Configuration

  1. Create a config file (it will be located in ~/.config/quickci/tokens.json):

    $ quickci config create
  2. Replace placeholders with your own authentication tokens:

    $ quickci config update <service> <token>
Available services are:
  • Travis CI: travis

  • CircleCI: circle

  • AppVeyor: appveyor

  • Buddy: buddy

  • Drone: drone

  1. Check that everything is correct:

    $ quickci config show

Check build status

Check the build status of your projects:

$ quickci status

The build status of your Travis CI, CircleCI, AppVeyor, Buddy and Drone projects will be returned (master branch). If you want to monitor one specific branch of your repositories (suppose you have many repos with a dedicated dev branch for development), you can easily add the --branch <branch_name> option:

$ quickci status --branch dev

If the --branch option is not provided, the build status of the master branch will be retrieved by default.

If you want to check one specific repository, you can provide the --repo <reponame> option:

$ quickci status --repo my_repo

It is obviously possible to combine the --repo and --branch options to check a given branch of a specific repository.

It is also possible to check a specific service using subcommands of quickci status:

$ quickci status travis
$ quickci status circle
$ quickci status appveyor
$ quickci status buddy
$ quickci status drone

These subcommands also accept the --branch and --repo options. If the token for a specific service is not listed in ~/.config/quickci/tokens.json, it is possible to provide it using the --token <service_token> option:

$ quickci status travis --token <TravisCI token>

Please refer to the Usage section of the documentation for further information.

Installation

quickCI can be installed using pip (Python>=3.6 only):

$ pip install quickci

Please refer to the Installation section of the documentation for further information.

Credits

This package was created with Cookiecutter and the cc-pypackage project template.

History

0.1.0 (2019-04-20)

  • First release.

0.1.1 (2019-04-29)

  • Update Config methods and attributes for better handling of tokens;

  • Update CLI commands.

0.1.2 (2019-06-03)

  • Minor code fix;

  • Update requirements and documentation;

  • Fix AppVeyor request class and add GitLab draft.

0.1.3 (2019-06-06)

  • Add Buddy class.

0.1.4 (2019-06-07)

  • Change fetching functions to asyncio.

0.2.0 (2019-07-02)

  • Change config and status commands to group commands and add related subcommands;

  • Change classes to use concurrent functions when possible;

  • Clean code.

0.2.1 (2019-07-03)

  • Fix imports and tox test config.

0.2.2 (2019-07-03)

  • Fix setup.py installation process;

  • Update documentation.

0.2.3 (2019-07-13)

  • Add Drone CI class and CLI commands;

  • Update tests;

  • Update documentation.

0.3.0 (2019-07-28)

  • Add --branch option to check for specific branch;

  • Update documentation.

0.4.0 (2019-12-12)

  • Add --repo option to check for a specific repository;

  • Update documentation.

Project details


Download files

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

Source Distribution

quickci-0.4.0.tar.gz (18.4 kB view hashes)

Uploaded source

Built Distribution

quickci-0.4.0-py2.py3-none-any.whl (11.4 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page