add contents webservice by minrk · Pull Request #5938 · ipython/ipython

minrk · 2014-06-03T03:23:33Z

This mainly renames the 'notebooks' service to 'contents' and teaches it about regular files. There is no longer special treatment of directories, just different forms for content. Tree view now shows all files.

As usual, modeled on GitHub contents API.

I will enumerate the changes to the models and API, but the gist:

all contents models have name, path, dates, type
type is one of: directory, file, notebook
if content is requested:
- additional format key will be json, text, or base64, describing content
- content will be
  - list of JSON models for directory contents
  - notebook JSON for notebooks (format=json)
  - file text for text files (format=text)
  - b64-encoded data for binary files (format=base64)

ellisonbg · 2014-06-11T17:11:50Z

...if the file exists, else returns False....

andreabedini · 2014-06-16T09:25:18Z

Is there a roadmap/IPEP for the contents web-service? I'm working to port bookstore notebook manager to IPython 2 and I feel like I'm late to the party.

minrk · 2014-06-16T16:06:36Z

I'm still working on the IPEP, I'll link to it when I put it up.

minrk · 2014-06-16T20:08:56Z

I've posted the current state of the IPEP

andreabedini · 2014-06-16T22:45:23Z

Thanks @minrk

minrk · 2014-06-17T18:58:47Z

The /files/ handler should be handled by the ContentsManager, but I don't want to deal with that in this PR.

As of ipython/ipython#5938: Use contents webservice instead of own websocket server.

Remove own websocket service and use new IPython contents webservice: ipython/ipython#5938

minrk · 2014-06-30T17:54:12Z

Rebased, and review should be addressed. I don't have anything else planned to do here.

ellisonbg · 2014-06-30T17:56:17Z

I do have other review that I am doing on this one - will try to get
comments to you soon, but not today - writing a letter for our BFDL...

On Mon, Jun 30, 2014 at 10:54 AM, Min RK notifications@github.com wrote:

Rebased, and review should be addressed. I don't have anything else
planned to do here.

—
Reply to this email directly or view it on GitHub
#5938 (comment).

Brian E. Granger
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
bgranger@calpoly.edu and ellisonbg@gmail.com

ellisonbg · 2014-06-30T17:56:35Z

That is BDFL...

On Mon, Jun 30, 2014 at 10:56 AM, Brian Granger ellisonbg@gmail.com wrote:

I do have other review that I am doing on this one - will try to get
comments to you soon, but not today - writing a letter for our BFDL...

On Mon, Jun 30, 2014 at 10:54 AM, Min RK notifications@github.com wrote:

Rebased, and review should be addressed. I don't have anything else
planned to do here.

—
Reply to this email directly or view it on GitHub
#5938 (comment).

Brian E. Granger
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
bgranger@calpoly.edu and ellisonbg@gmail.com

Brian E. Granger
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
bgranger@calpoly.edu and ellisonbg@gmail.com

fperez · 2014-06-30T18:00:44Z

Happy to hop in, I can ask @minrk to fill me in the details to save you time, @ellisonbg.

fperez · 2014-06-30T18:01:38Z

Sorry, misunderstood the ping... Yes, please stick to that letter ;)

minrk · 2014-07-12T16:59:58Z

Rebased on require.

ellisonbg · 2014-07-22T17:30:37Z

"Serving contents"

takluyver · 2014-07-29T22:33:52Z

Should the contents manager have methods/parameters for things like "does this exist and is it a notebook", or "load this, throwing an error if it is not a notebook"?

I don't think it's necessary. The caller can always check the type field in the model if it's desired.

minimal functional changes, committing because tests are passing.

- missed some s/notebook/file/ in docstrings - manager doesn’t sort contents

can’t copy directories

avoids 404 on /files for visiting a nonexistent notebook

a few more notebook mentions in docstrings, and inappropriate use of setdefault.

and reuse it in /nbconvert/html/… closes ipython#6137

- clarified docstrings and errors - still more notebook/file renames - configurable untitled names - copy_from can be full path - fix running, upload, new-tab behaviors in dashboard Yay, review!

- recognize 201 as success (dataType must not be 'json') - support uploading non-notebook files (b64-encoded)

- fix is_hidden always returning True on nonexistent files - create hidden dir fails with 400 - don't read binary files twice - logging improvements - dialog on invalid notebook upload - warn about disabled `--save`

add contents webservice

minrk · 2014-07-31T19:25:00Z

Merged, yay!

ellisonbg · 2014-08-01T17:14:46Z

Great work!

On Thu, Jul 31, 2014 at 12:25 PM, Min RK notifications@github.com wrote:

Merged, yay!

—
Reply to this email directly or view it on GitHub
#5938 (comment).

Brian E. Granger
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
bgranger@calpoly.edu and ellisonbg@gmail.com

add contents webservice

ellisonbg reviewed Jun 11, 2014
View reviewed changes

Comment thread IPython/html/services/contents/manager.py Outdated

Copy link
Copy Markdown

Member

ellisonbg Jun 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...if the file exists, else returns False....

Carreau mentioned this pull request Jun 15, 2014

MacOS finder-like notebook manager #5989

Closed

juhasch pushed a commit to ipython-contrib/jupyter_contrib_nbextensions that referenced this pull request Jun 17, 2014

Use new contents webservice

111e49b

As of ipython/ipython#5938: Use contents webservice instead of own websocket server.

juhasch pushed a commit to juhasch/jupyter_contrib_nbextensions that referenced this pull request Jun 18, 2014

Use new contents webservice

a50e310

Remove own websocket service and use new IPython contents webservice: ipython/ipython#5938

minrk added this to the 3.0 milestone Jun 30, 2014

This was referenced Jul 15, 2014

Notebook print preview is not including correctly the linked images #6137

Closed

Allow Creating Subdirectories within Ipython Notebook #6157

Closed

ellisonbg reviewed Jul 22, 2014
View reviewed changes

Comment thread IPython/html/services/contents/manager.py Outdated

Copy link
Copy Markdown

Member

ellisonbg Jul 22, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Serving contents"

takluyver reviewed Jul 29, 2014
View reviewed changes

takluyver added Waiting for author and removed Needs review labels Jul 29, 2014

minrk added Needs review and removed Waiting for author labels Jul 29, 2014

minrk added 16 commits July 31, 2014 11:57

mv services/notebooks services/contents

e918eb5

rename notebooks service to contents service

48c2b3d

minimal functional changes, committing because tests are passing.

teach contents service about non-notebook files

dbd4c50

teach tree view about non-notebook files

98ccb25

add support and tests for uploading and saving regular files

f8d34e1

test creating a directory with PUT

2bee5e5

contents service review

fb8cd39

- missed some s/notebook/file/ in docstrings - manager doesn’t sort contents

support deleting empty directories

35c8d20

can’t copy directories

use contents manager to handle redirect of /notebooks -> /files

ec353c7

avoids 404 on /files for visiting a nonexistent notebook

updates per review

b334379

a few more notebook mentions in docstrings, and inappropriate use of setdefault.

move /files/ redirect to base handlers

8f08d4e

and reuse it in /nbconvert/html/… closes ipython#6137

whatsnew for contents service

8c324cd

updates per review

920c0ba

- clarified docstrings and errors - still more notebook/file renames - configurable untitled names - copy_from can be full path - fix running, upload, new-tab behaviors in dashboard Yay, review!

various upload fixes

459d507

- recognize 201 as success (dataType must not be 'json') - support uploading non-notebook files (b64-encoded)

update contents per further review

96cae31

- fix is_hidden always returning True on nonexistent files - create hidden dir fails with 400 - don't read binary files twice - logging improvements - dialog on invalid notebook upload - warn about disabled `--save`

remove unused project_dir

5318299

minrk added a commit that referenced this pull request Jul 31, 2014

Merge pull request #5938 from minrk/contents2

6ecbe72

add contents webservice

minrk merged commit 6ecbe72 into ipython:master Jul 31, 2014

minrk deleted the contents2 branch July 31, 2014 19:24

mattvonrocketstein pushed a commit to mattvonrocketstein/ipython that referenced this pull request Nov 3, 2014

Merge pull request ipython#5938 from minrk/contents2

366ec64

add contents webservice

vidartf mentioned this pull request Jan 30, 2025

Don't hide .so,.dylib files by default jupyter-server/jupyter_server#1457

Merged

Uh oh!

Conversation

minrk commented Jun 3, 2014

Uh oh!

ellisonbg Jun 11, 2014

Choose a reason for hiding this comment

Uh oh!

andreabedini commented Jun 16, 2014

Uh oh!

minrk commented Jun 16, 2014

Uh oh!

minrk commented Jun 16, 2014

Uh oh!

andreabedini commented Jun 16, 2014

Uh oh!

minrk commented Jun 17, 2014

Uh oh!

minrk commented Jun 30, 2014

Uh oh!

ellisonbg commented Jun 30, 2014

Uh oh!

ellisonbg commented Jun 30, 2014

Uh oh!

fperez commented Jun 30, 2014

Uh oh!

fperez commented Jun 30, 2014

Uh oh!

minrk commented Jul 12, 2014

Uh oh!

ellisonbg Jul 22, 2014

Choose a reason for hiding this comment

Uh oh!

takluyver Jul 29, 2014

Choose a reason for hiding this comment

Uh oh!

minrk Jul 29, 2014

Choose a reason for hiding this comment

Uh oh!

minrk commented Jul 31, 2014

Uh oh!

ellisonbg commented Aug 1, 2014

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants