Skip to content

Commit

Permalink
More badges, readme impr
Browse files Browse the repository at this point in the history
  • Loading branch information
tribal-tec committed Jul 25, 2018
1 parent e44d673 commit f63bf6e
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[![Build Status](https://travis-ci.org/tribal-tec/Brayns.svg?branch=pypi)](https://travis-ci.org/tribal-tec/Brayns)
[![Documentation Status](https://readthedocs.org/projects/brayns/badge/?version=latest)](http://brayns.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://bbpcode.epfl.ch/ci/buildStatus/icon?job=oss.Brayns)](https://bbpcode.epfl.ch/ci/job/oss.Brayns/)
[![Travis (.org)](https://img.shields.io/travis/tribal-tec/Brayns/pypi.svg)](https://travis-ci.org/tribal-tec/Brayns)
[![Read the Docs](https://img.shields.io/readthedocs/brayns.svg)](http://brayns.readthedocs.io/en/latest/?badge=latest)
[![Docker Pulls](https://img.shields.io/docker/pulls/bluebrain/brayns.svg)](https://hub.docker.com/r/bluebrain/brayns/)
[![GitHub release](https://img.shields.io/github/release/BlueBrain/Brayns.svg)](https://github.com/BlueBrain/Brayns/releases)

# Brayns

Expand Down
1 change: 1 addition & 0 deletions python/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ pylint.txt
dist/
.tox/
venv/
doc/source/.ipynb_checkpoints/
11 changes: 7 additions & 4 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,17 @@ This installs `Brayns` into your `virtualenv` in "editable" mode. That means cha
made to the source code are seen by the installation. To install in read-only mode, omit
the `-e`.

## Get started

Simple connect:
## Connect to running Brayns instance

```python
>>> from brayns import Client

>>> brayns = brayns.Client('localhost:8200')
>>> brayns = Client('localhost:8200')
>>> print(brayns)
Brayns version 0.7.0.c52dd4b running on http://localhost:8200/
```

## Examples

Please find some examples how to interact with Brayns from python on
[`Read the Docs`](https://brayns.readthedocs.io/en/latest/examples.html).

0 comments on commit f63bf6e

Please sign in to comment.