Skip to content

Commit

Permalink
Update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
ahal committed Mar 16, 2020
1 parent aef66e6 commit bc8f4c3
Showing 1 changed file with 49 additions and 1 deletion.
50 changes: 49 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,53 @@
[![Build Status](https://travis-ci.org/mozilla/mozci.svg?branch=master)](https://travis-ci.org/mozilla/mozci)
[![PyPI version](https://badge.fury.io/py/mozci.svg)](https://badge.fury.io/py/mozci)
[![Docs](https://readthedocs.org/projects/mozci/badge/?version=latest)](https://mozci.readthedocs.io/en/latest/?badge=latest)

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


## Installation

To install, run:

```bash
$ pip install mozci
```


## Usage

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

```python3
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](https://python-poetry.org/docs/) for more usage details and API docs.


## Contributing

Mozci uses [poetry](https://python-poetry.org/) to manage the project. So first make sure that is
installed. Then run:

```bash
$ poetry install
```

This will create a virtualenv and install both project and dev dependencies in it. See the [poetry
documentation](https://python-poetry.org/docs/) to learn how to work within the project.

To execute tests and linters, run:

```bash
$ tox
```

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

0 comments on commit bc8f4c3

Please sign in to comment.