Skip to content

Commit a36e494

Browse files
committed
Improve Readme and set patch version number
1 parent d7814f8 commit a36e494

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Scipy Trait Types
2+
3+
[![Build Status](https://travis-ci.org/jupyter-incubator/traittypes.svg?branch=master)](https://travis-ci.org/jupyter-incubator/traittypes)
4+
25
Trait types for NumPy, SciPy and friends
36

4-
### Goals
7+
## Goals
58

69
Provide a reference implementation of trait types for common data structures used in the scipy stack such as
710
- numpy arrays
@@ -10,3 +13,12 @@ Provide a reference implementation of trait types for common data structures use
1013
which are out of the scope of the main [traitlets](https://github.com/ipython/traitlets) project but are a common requirement to build applications with traitlets in combination with the scipy stack.
1114

1215
Another goal is to create adequate serialization and deserialization routines for these trait types to be used with the [ipywidgets](https://github.com/ipython/ipywidgets) project (`to_json` and `from_json`). These could also return a list of binary buffers as allowed by the current message protocol.
16+
17+
## Installation
18+
19+
For a local installation, make sure you have
20+
[pip installed](https://pip.readthedocs.org/en/stable/installing/) and run:
21+
22+
```
23+
pip install traittypes
24+
```

traittypes/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
version_info = (0, 1, 0, 'dev')
1+
version_info = (0, 0, 1)
22
__version__ = '.'.join(map(str, version_info))

0 commit comments

Comments
 (0)