Skip to content
This repository was archived by the owner on Jul 20, 2020. It is now read-only.
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions README.RST
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
PPExtensions
============

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.

--------
Features
--------
- **PPMagics** - Set of magics to simplify access to different storage systems and tableau.
- **Github Integration** - A jupyter extension to integrate notebooks with github. This extension simplifies version controlling, sharing and resolving merge conflicts of notebooks.
- **Notebooks Scheduling** - A jupyter extension to productionalize the notebooks development environment. This extension enables scheduling notebooks with help of `airflow <https://airflow.apache.org/>`_.
- **Config UI** - A simple UI built to change the configurations of different extensions like PPMagic, `sparkmagic <https://github.com/jupyter-incubator/sparkmagic/>`_ ..etc.


------------
Installation
------------
pip install ppextensions


-------------
Current State
-------------

+-----------+-----------+-------+
| Feature | Available | State |
+===========+===========+=======+
| PPMagics | Available | Beta |
+-----------+-----------+-------+
| Scheduler | Available | Beta |
+-----------+-----------+-------+
| Github | Available | Bet |
+-----------+-----------+-------+


-------------------------------
Documentation & Getting Started
-------------------------------

`Click here to read the docs <http://ppextensions.readthedocs.io/>`_

---------
Questions
---------

- `Slack <https://ppextensions.slack.com>`_
- `User Forum <https://groups.google.com/d/forum/ppextensions>`_
- `Developer Forum <https://groups.google.com/d/forum/ppextensions>`_

3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Build Status](https://travis-ci.org/paypal/PPExtensions.svg?branch=master)](https://travis-ci.org/paypal/PPExtensions)
[![Documentation Status](https://readthedocs.org/projects/ppextensions/badge/?version=latest)](http://ppextensions.readthedocs.io/en/latest/?badge=latest)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a3452d2e00d2458bb79c6ba5f36b5b7a)](https://www.codacy.com/project/Dee-Pac/PPExtensions/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=paypal/PPExtensions&amp;utm_campaign=Badge_Grade_Dashboard)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a159cd4835e34c8abb1d738ff996d065)](https://www.codacy.com/app/ppextensions-team/PPExtensions?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=paypal/PPExtensions&amp;utm_campaign=Badge_Grade)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

# PPExtensions
Expand Down Expand Up @@ -39,4 +39,3 @@ PPExtensions is a suite of ipython and jupyter extensions built to improve user
* [Slack](https://ppextensions.slack.com)
* [User Forum](https://groups.google.com/d/forum/ppextensions)
* [Developer Forum](https://groups.google.com/d/forum/ppextensions)

4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ PPExtensions is a suite of ipython and jupyter extensions built to improve user

* [Click here to read the docs](http://ppextensions.readthedocs.io/)

# Contributing

* [Edit in Github](https://github.com/paypal/PPExtensions/)

# Questions

* [Slack](https://join.slack.com/t/ppextensions/shared_invite/enQtNDIyODk5NzYzMzEyLTIwOGM3MWE0OGZlNjFkYTUxZTJiN2NjOWFlNmUxNDRiY2U3MzE0Nzg5NDRjZjE2M2VmZGI4NWJhOGVjYTRiMTk)
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
LICENSE = 'BSD License'

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

VERSION = '0.0.5'

Expand Down