Skip to content
This repository was archived by the owner on Jul 20, 2020. It is now read-only.

Commit f82f895

Browse files
author
Kanamarlapudi, Praveen(pkanamarlapudi)
committed
Added README.RST to format properly in pypi.org
1 parent b2442bf commit f82f895

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

README.RST

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
PPExtensions
2+
============
3+
4+
PPExtensions is a suite of ipython and jupyter extensions built to improve user experience and reduce time to market in `Jupyter <http://jupyter.org/>`_ notebooks.
5+
6+
--------
7+
Features
8+
--------
9+
- **PPMagics** - Set of magics to simplify access to different storage systems and tableau.
10+
- **Github Integration** - A jupyter extension to integrate notebooks with github. This extension simplifies version controlling, sharing and resolving merge conflicts of notebooks.
11+
- **Notebooks Scheduling** - A jupyter extension to productionalize the notebooks development environment. This extension enables scheduling notebooks with help of `airflow <https://airflow.apache.org/>`_.
12+
- **Config UI** - A simple UI built to change the configurations of different extensions like PPMagic, `sparkmagic <https://github.com/jupyter-incubator/sparkmagic/>`_ ..etc.
13+
14+
15+
------------
16+
Installation
17+
------------
18+
pip install ppextensions
19+
20+
21+
-------------
22+
Current State
23+
-------------
24+
25+
+-----------+-----------+-------+
26+
| Feature | Available | State |
27+
+===========+===========+=======+
28+
| PPMagics | Available | Beta |
29+
+-----------+-----------+-------+
30+
| Scheduler | Available | Beta |
31+
+-----------+-----------+-------+
32+
| Github | Available | Bet |
33+
+-----------+-----------+-------+
34+
35+
36+
-------------------------------
37+
Documentation & Getting Started
38+
-------------------------------
39+
40+
`Click here to read the docs <http://ppextensions.readthedocs.io/>`_
41+
42+
---------
43+
Questions
44+
---------
45+
46+
- `Slack <https://ppextensions.slack.com>`_
47+
- `User Forum <https://groups.google.com/d/forum/ppextensions>`_
48+
- `Developer Forum <https://groups.google.com/d/forum/ppextensions>`_
49+

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
LICENSE = 'BSD License'
1313

1414
here = os.path.abspath(os.path.dirname(__file__))
15-
README = open(os.path.join(here, 'README.md'), encoding='utf-8').read()
15+
README = open(os.path.join(here, 'README.RST'), encoding='utf-8').read()
1616

1717
VERSION = '0.0.5'
1818

0 commit comments

Comments
 (0)