Skip to content

Commit cbc7f72

Browse files
committed
Updated README
1 parent c39a17f commit cbc7f72

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
1+
[![Travis Build Status](https://travis-ci.org/jupyter/nbclient.svg?branch=master)](https://travis-ci.org/jupyter/nbclient)
2+
[![image](https://codecov.io/github/jupyter/nbclient/coverage.svg?branch=master)](https://codecov.io/github/jupyter/nbclient?branch=master)
3+
[![Python 3.5](https://img.shields.io/badge/python-3.5-blue.svg)](https://www.python.org/downloads/release/python-350/)
4+
[![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/)
5+
[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
6+
[![Python 3.8](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/downloads/release/python-380/)
7+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
8+
19
# nbclient
210

311
A client library for executing notebooks. Formally nbconvert's ExecutePreprocessor.
412

5-
## TODO: Add more details here!
13+
**NBClient** is a tool for parameterizing and executing Jupyter Notebooks.
14+
15+
NBClient lets you:
16+
17+
**execute** notebooks
18+
19+
Similar in nature to jupyter_client, as the jupyter_client is to the jupyter
20+
protocol nbclient is to notebooks allowing for execution contexts to be run.
21+
22+
## Origins
23+
24+
This library used to be part of [nbconvert](https://nbconvert.readthedocs.io/en/latest/) and was extracted into it's own library for easier updating and importing by downstream libraries and applications.
25+
26+
## Python Version Support
27+
28+
This library currently supports python 3.5+ verisons. As minor python
29+
versions are officially sunset by the python org nbclient will similarly
30+
drop support in the future.
31+
32+
## Documentation
33+
34+
See [readthedocs](https://nbclient.readthedocs.io/en/latest/) for more in-depth details about the project and API capabilities.

0 commit comments

Comments
 (0)