A library for inspecting push and task results in Mozilla's CI
Перейти к файлу
Marco Castelluccio 9ebb4a7199 Bump adr from 0.17.8 to 0.17.9 2020-04-15 00:19:19 +02:00
docs docs: add errors to API docs, add links in docstrings 2020-04-07 09:31:36 -04:00
mozci Create a Task.to_json() helper to JSONify a task instance 2020-04-14 14:00:10 -04:00
tests Create a Task.to_json() helper to JSONify a task instance 2020-04-14 14:00:10 -04:00
.flake8 Use black and pre-commit (#70) 2020-02-26 17:05:30 +01:00
.gitignore larger resultset 2020-01-12 09:42:47 -05:00
.isort.cfg Use black and pre-commit (#70) 2020-02-26 17:05:30 +01:00
.pre-commit-config.yaml Disable 'check-docstring-first' pre-commit hook 2020-03-25 09:58:31 -04:00
.travis.yml Use black and pre-commit (#70) 2020-02-26 17:05:30 +01:00
LICENSE Initial commit 2019-11-28 15:53:22 -05:00
README.md Update README.md 2020-03-17 12:49:24 -04:00
poetry.lock Bump adr from 0.17.8 to 0.17.9 2020-04-15 00:19:19 +02:00
pyproject.toml Bump adr from 0.17.8 to 0.17.9 2020-04-15 00:19:19 +02:00
requirements.readthedocs.txt Add some basic Sphinx documentation 2020-03-16 12:47:51 -04:00
tox.ini tests: Add TRAVIS_EVENT_TYPE to tox's passenv key 2020-04-02 08:55:52 -04:00

README.md

Build Status PyPI version Docs

mozci

A library for inspecting push and task results in Mozilla's CI.

Installation

To install, run:

$ pip install mozci

Usage

Basic usage is to instantiate a Push object then start accessing properties and call methods. For example:

from mozci.push import Push

push = Push("79041cab0cc2", branch="autoland")
print("\n".join([t.label for t in push.tasks if t.failed])

This will print all the failing tasks from a given push. See the documentation for more usage details and API docs.

Contributing

Mozci uses poetry to manage the project. So first make sure that is installed. Then clone the repo and run:

$ poetry install

This will create a virtualenv and install both project and dev dependencies in it. See the poetry documentation to learn how to work within the project.

To execute tests and linters, run:

$ tox

This should run successfully prior to submitting PRs (unless you need help figuring out the problem).

There are also some integration tests that will hit live data sources. These are run in a cron task and are excluded from the default test run. But if needed, you can run them locally via:

$ tox -e integration