paypal / ppextensions

Set of iPython and Jupyter extensions to improve user experience

PPExtensions

PPExtensions is a suite of ipython and jupyter extensions built to improve user experience and reduce time to market in Jupyter 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 Apache Airflow.

Installation

pip install ppextensions

Current State

Feature	Available	State
PPMagics	Available	Beta
Scheduling Notebooks	Available	Beta
Github Integration	Available	Beta

---

Documentation & Getting Started

• Click here to read the docs

Questions

• Slack
• User Forum
• Developer Forum

ppextensions's Issues

Add Codacy Integration & Badge

What feature are your requesting?

• Add integration with Codacy , plus Badge

What benefits do you foresee from the feature you are requesting?

• Codacy automatically runs checks on PR, runs checks on Branches - reports several dimensions of code quality that can be improved.
• See here --> https://app.codacy.com/project/Dee-Pac/PPExtensions/dashboard

Potential solution/ideas?

Additional context

Add Pull Request Template

We can use tableau server APIs to publish to tableau

We can use tableau server APIs to publish to tableau.

Example: https://tableau.github.io/server-client-python/docs/

Could not find a version that satisfies the requirement ppextensions

MAC:~ dmohanakumarchan$ pip install ppextensions

  Could not fetch URL https://pypi.python.org/simple/ppextensions/: There was a problem confirming the ssl certificate: [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol version (_ssl.c:590) - skipping
  Could not find a version that satisfies the requirement ppextensions (from versions: )
No matching distribution found for ppextensions```

[Documentation] Add GITHUB Link & Icon to docs/index.md

What feature are your requesting?

• Add GITHUB Link & Icon to docs/index.md

What benefits do you foresee from the feature you are requesting?

• readthedocs does not provide link such as "Edit in GitHub"

Potential solution/ideas?

• Add github official icon to docs/images
• Add a URL in Read the docs (doc/index.md) with reference as "Edit in Github"

Additional context

[Documentation] Add documentation for parameters.py

Update ppextentions version to concur with PyPi package version

Describe the bug
Update ppextentions version to 0.0.4 to concur with PyPi package version.

To Reproduce

Expected behavior

Screenshots

Potential fix

[Documentation] Add Downloads Badge to the README

What feature are your requesting?

• Add badge for Downloads

What benefits do you foresee from the feature you are requesting?

• Usage Statistics

Potential solution/ideas?

• How to get a Badge for Downloads : https://shields.io/#/examples/downloads

Additional context

[Documentation] NIT : readthedocs page has cyclic reference to itself

Describe the bug

To Reproduce

Edit doc/index.md --> Remove this section "click here to read the documentation"

Expected behavior

• Remove the section
• Have a link to GITHUB as mentioned in #34

Screenshots

That section is redundant & cyclic. It is probably here because same markdown is copied from README.md.

Potential fix

Reformat index.md

What feature are your requesting?

Reformat index.md

What benefits do you foresee from the feature you are requesting?

Latest update on the availability

Potential solution/ideas?

Additional context

Simplify github token registration process

What feature are your requesting?
Simplify github token registration process

What benefits do you foresee from the feature you are requesting?
Simplifies user experience and multiple hooks in the using the extension.

Potential solution/ideas?

1. Create a register github token button in notebooks UI.
2. Ask for user credentials on clicking the button.
3. Authenticate with github and store the token securely and reuse.

Additional context

Hive Magic Results are right indented

Describe the bug

The results of Hive queries are right indented. It should be left indented as standard output.

To Reproduce

%%hive --hive_server 34.66.242.234 --port 10025
show create table tmp

Expected behavior

The columns in the results must be right indented.

Screenshots

Potential fix

Add mkdocs yaml file to render readthedocs theme

Describe the bug
Read the docs is not rendering well.

To Reproduce
Open ppextensions.io

Expected behavior

Screenshots

Potential fix

PPUtils Unittests

What feature are your requesting?
Unittests for PPUtils

What benefits do you foresee from the feature you are requesting?
Initially test-cases for PPExtensions utility functions

Part of #6

[Documentation] ReadTheDocs - epub and pdf are not showing the full documentation

Describe the bug
In https://ppextensions.readthedocs.io/, download documentation as PDF and Epub are having full documentation.

To Reproduce

1. Open https://ppextensions.readthedocs.io/
2. Click Read the Docs left hand bottom corner
3. Click PDF, or Epub in Downloads section

Expected behavior
It should have full documentation about ppextensions

Screenshots

Potential fix

Create a CI pipelines for PRs

[Documentation] Create gifs/videos explaining steps to use extensions

What feature are your requesting?
Create gifs/videos explaining steps to use extensions

What benefits do you foresee from the feature you are requesting?
Acts as a quick documentation to new users.

Potential solution/ideas?
Create videos

Additional context

Remove Tableau sdk as dependency to install

Describe the bug
Tableau sdk should be present for pip install ppextensions to work. Remove it as a dependency

To Reproduce

Expected behavior
pip install works without tableausdk and tableausdk is required only to use tableau feature

Screenshots

Potential fix

Sync develop branch with master

What feature are your requesting?
Sync develop branch with master, so the future pull requests will go to develop.

What benefits do you foresee from the feature you are requesting?
NA

Potential solution/ideas?
NA

Additional context
Moving all changes from master to develop, so the future pull requests will go to develop.

Some dependencies are missing

Some dependencies are missing

Add Badges for CI Build

Dependent on #8 - once complete - add the badge to readme.md

NIT: Change reference to airflow to Apache Airflow in Readme

Just a nit. Changing airflow to Apache Airflow!

Can't find the schedule button appeared in the dynamic tool bar.

I try to install PPExtensions by command "pip install ppextensions" , the version 0.0.4 is installed.
but when i execute "jupyter nbextension install scheduler --user --py "
can't find the scheduler module.
so i try to "pip install ." from the src, the version 0.0.5 is installed.
and i copy the scheduler folder into conda env. and then i can get the "scheduled jobs" page,
but i still can't find the schedule button appeared in the dynamic tool bar.
how should i do to get it.
i really need u help, hope you reply. thanks.

Links are appearing as plaintext in readme.

To see the issue, check the section in https://ppextensions.readthedocs.io/en/latest/#questions
under

• Documentation & Getting Started
• Questions

Add Issue Template

Add Templates for Bugs & Features requests

Update Pre requisite Documenatation

Remove Tableausdk as dependency from prerequisites and mention it in the required place

[Open Source] Push PPExtensions

Add BSD-3 Badge

Add some sample notebooks

[Documentation] Rearrange the docs

Update broken codacy badge

Describe the bug
Update broken codacy badge in readme

To Reproduce

Expected behavior

Screenshots

Potential fix

Results are not rendering from CSV Magic.

Describe the bug
Results are not rendering when CSV magic is used to read a CSV file.

To Reproduce

Expected behavior

Screenshots

Potential fix

Failing | pip install ppextensions

• Issue

PP Extensions is not installing on my mac

• Reproduced via

MAC:~ dmohanakumarchan$ pip install ppextensions

Collecting ppextensions
  Using cached https://files.pythonhosted.org/packages/f3/f8/af42cb9209a1c98bd8cef089605bdb40b43568a38f5f1f42041a04778ddd/ppextensions-0.0.4.tar.gz
    Complete output from command python setup.py egg_info:
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
      File "/private/var/folders/p9/v9t3kcn92vj9055qsg1pt9pc392gjp/T/pip-install-DZ0n2I/ppextensions/setup.py", line 14, in <module>
        README = open(os.path.join(here, 'README.md'), encoding='utf-8').read()
    TypeError: 'encoding' is an invalid keyword argument for this function
    
    ----------------------------------------
Command "python setup.py egg_info" failed with error code 1 in /private/var/folders/p9/v9t3kcn92vj9055qsg1pt9pc392gjp/T/pip-install-DZ0n2I/ppextensions/
You are using pip version 18.0, however version 18.1 is available.
You should consider upgrading via the 'pip install --upgrade pip' command.
MAC:~ dmohanakumarchan$ 

Add readthedocs Badge to Readme

Unable to join two csv files using %csv magic

Describe the bug
If I have two csv files and trying to join both, it's not working.

To Reproduce

1. Let's say we have a cust.csv file with cust_id, cust_name
2. Another CSV file named geo.csv file with cust_id, city, zipcode

Run a sql like below
%csv select cust_name, city from cust.csv as a join geo.csv as b on a.cust_id = b.cust_id

Expected behavior
The sql should join both the table and give cust_id and city info in a table.

Screenshots

Potential fix

Add testcases

Enable notebooks scheduling

What feature are your requesting?
Enable notebooks scheduling

What benefits do you foresee from the feature you are requesting?
Productionalizing the notebooks.

Potential solution/ideas?
Integrating with a scheduler like airflow.

Pre-polutate repositories while doing git pull

What feature are your requesting?
Pre-poluate repository while doing git pull for already pulled repository.

What benefits do you foresee from the feature you are requesting?
Easy of use to the users

Potential solution/ideas?
Store the repository metadata