Merge branch 'master' of https://github.com/ipython-contrib/jupyter_contrib_nbextensions

Author: juhasch

CHANGELOG.md

@@ -21,6 +21,16 @@ Unreleased (aka. GitHub master)
 This is where each new PR to the project should add a summary of its changes,
 which makes it much easier to fill in each release's changelog :)
 
+0.5.1
+-----
+
+- Fix for navigation hotkeys [#1378](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1378)
+- `gist_it` Making github endpoint configurable to support publishing gists to Github Enterprise [#1364](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1364)
+- Fix treefilter [#1359](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1359)
+- Enable ruler extension in editor [#1296](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/pull/1296)
+- Several spelling fixes
+
+Travis/AppVeyor testing is currently broken due to outdated configuration. Will hopefully be working in 0.5.2 again.
 
 0.5.0
 -----

CONTRIBUTING.md

@@ -2,6 +2,9 @@
 
 We are super happy that you intend to contribute to the nbextensions! You can discuss improvements in issues and implement them in pull requests.
 
+Because this is a volunteer effort, we cannot provide support for all of the extensions.
+So if you contribute a new extension, please stick around and help others using it.
+
 ## Create an issue
 
 Do not hesitate to open up an issue, you can discuss bugs, improvements or new extensions in them. Creating an issue is a good starting point for code contributions. The community can support you with experience of similar extensions, pros and cons, what to look for etc.

docs/source/conf.py

@@ -41,9 +41,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.5.0'
+version = '0.5.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.5.0'
+release = '0.5.1'
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of strings

setup.py

@@ -42,14 +42,14 @@ def main():
 `the repository issues page <https://github.com/ipython-contrib/jupyter_contrib_nbextensions/issues>`_
 if you encounter any problems, and create a new issue if needed!
 """,  # noqa: E501
-        version='0.5.0',
+        version='0.5.1',
         author='ipython-contrib and jupyter-contrib developers',
         author_email='[email protected]',
         url=('https://github.com/'
              'ipython-contrib/jupyter_contrib_nbextensions.git'),
         download_url=('https://github.com/'
                       'ipython-contrib/jupyter_contrib_nbextensions'
-                      '/tarball/0.5.0'),
+                      '/tarball/0.5.1'),
         keywords=['IPython', 'Jupyter', 'notebook'],
         license='BSD',
         platforms=['Any'],

src/jupyter_contrib_nbextensions/__init__.py

@@ -4,7 +4,7 @@
 
 import jupyter_nbextensions_configurator
 
-__version__ = '0.5.0'
+__version__ = '0.5.1'
 
 
 def _jupyter_server_extension_paths():

src/jupyter_contrib_nbextensions/nbextensions/code_prettify/README.md

@@ -239,6 +239,20 @@ to use [autopep8] instead of [yapf] to reformat the python code.
 But, if you want two alternative prettifiers available for the same kernel
 language, we need to define separate plugins.
 
+Custom Yapf Styles
+------------------
+
+Using the default `yapf` engine, one may define a custom formatting style according to the [package documentation](https://github.com/google/yapf#formatting-style).
+
+The `code_prettify` extension is configured to follow the default `yapf` ordering (minus the command line option) and will search for the formatting style in the following manner:
+
+> 1. In the [style] section of a .style.yapf file in either the current directory or one of its parent directories.
+> 2. In the [yapf] section of a setup.cfg file in either the current directory or one of its parent directories.
+> 3. In the ~/.config/yapf/style file in your home directory.
+>
+> If none of those files are found, the default style is used (PEP8).
+
+This means that one can set up a globa custom yapf style using `~/.config/yapf/style` or a project-specific one using the project directory.
 
 History
 -------
@@ -267,6 +281,9 @@ History
 - [@jfbercher], january 2017
   - updated documentation
   - added autopep8 nbextension as a plugin using the shared library
+- [@artificialsoph], Jan 2018
+  - updated documentation
+  - changed default behavior to load custom yapf styles
 
 
 [2to3]: README_2to3.md

src/jupyter_contrib_nbextensions/nbextensions/code_prettify/code_prettify.js

@@ -26,9 +26,12 @@ define(['./kernel_exec_on_cell'], function(kernel_exec_on_cell) {
             "library": ["import json",
             "def yapf_reformat(cell_text):", 
             "    import yapf.yapflib.yapf_api",
+            "    from yapf import file_resources",
+            "    import os",
             "    import re",
+            "    style_config = file_resources.GetDefaultStyleForDir(os.getcwd())",
             "    cell_text = re.sub('^%', '#%#', cell_text, flags=re.M)",
-            "    reformated_text = yapf.yapflib.yapf_api.FormatCode(cell_text)[0]",
+            "    reformated_text = yapf.yapflib.yapf_api.FormatCode(cell_text, style_config=style_config)[0]",
             "    return re.sub('^#%#', '%', reformated_text, flags=re.M)"].join("\n"),
             "prefix": "print(json.dumps(yapf_reformat(u",
             "postfix": ")))"

src/jupyter_contrib_nbextensions/nbextensions/codefolding/readme.md

@@ -17,7 +17,8 @@ Three different folding modes are supported:
 
 ### Indent Folding
 
-Python-style code folding, detetects indented code.
+In the image below, the Codefolding extension detects unfolded, Python-style indentations:
+
 ![Unfolded](codefolding_indent_unfolded.png)
 
 The unfolded code above can be folded like this:

src/jupyter_contrib_nbextensions/nbextensions/gist_it/gist_it.yaml

@@ -7,8 +7,12 @@ Link: readme.md
 Icon: icon.png
 Parameters:
 - name: gist_it_personal_access_token
-  description: (optional) Github personal access token.
+  description: Github personal access token. To write gists on a user's behalf, you need a token with the <a href="https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/">gist OAuth scope</a>.
   input_type: text
 - name: gist_it_default_to_public
   description: Gists default to public. If using a personal access token, gists will default to private. Set this to have them default to being public instead.
   input_type: checkbox
+- name: github_endpoint
+  description: Github endpoint. Defaults to 'github.com'. Change this to publish to your enterprise github endpoint.
+  input_type: text
+  default: 'github.com'

src/jupyter_contrib_nbextensions/nbextensions/gist_it/main.js

@@ -39,6 +39,7 @@ define([
     var params = {
         gist_it_default_to_public: false,
         gist_it_personal_access_token: '',
+        github_endpoint: 'github.com'
     };
 
     var initialize = function () {
@@ -170,8 +171,10 @@ define([
                 .addClass('fa-circle-o-notch fa-spin');
             // List commits as a way of checking whether the gist exists.
             // Listing commits appears to give the most concise response.
+            var github_endpoint = params.github_endpoint !== '' ? params.github_endpoint : 'github.com';
+
             $.ajax({
-                url: 'https://api.github.com/gists/' + id + '/commits',
+                url: 'https://api.'+ github_endpoint +'/gists/' + id + '/commits',
                 dataType: 'json',
                 beforeSend: add_auth_token,
                 error: function(jqXHR, textStatus, errorThrown) {
@@ -190,7 +193,7 @@ define([
                         help_block_html += '<p>' +
                             '<i class="fa fa-pencil-square"></i>' +
                             ' gist ' +
-                            '<a href="https://gist.github.com/' + id +
+                            '<a href="https://'+ github_endpoint + '/gist/' + id +
                             '" target="_blank">' + id + '</a> will be updated' +
                             ' (' + jqXHR.responseJSON.length +
                             ' revision' + (single ? '' : 's') +
@@ -440,9 +443,10 @@ define([
         var id = params.gist_it_personal_access_token !== '' ? id_input.val() : '';
         var method = id ? 'PATCH' : 'POST';
 
+        var github_endpoint = params.github_endpoint !== '' ? params.github_endpoint : 'github.com';
         // Create/edit the Gist
         $.ajax({
-            url: 'https://api.github.com/gists' + (id ? '/' + id : ''),
+            url: 'https://api.'+ github_endpoint +'/gists' + (id ? '/' + id : ''),
             type: method,
             dataType: 'json',
             data: JSON.stringify(data),