Presentations wrapper #739

Kully · 2017-04-23T17:19:04Z

No description provided.

Kully · 2017-04-23T17:24:13Z

…plotly (ops class)

Kully · 2017-05-03T19:32:18Z

The presentations wrapper can now do something. 🎉 Check out the example below:

import plotly.plotly as py
import plotly.presentation_objs as pres

markdown_string = """
---
# Slide 1: Text and Images (#)

This is slide 1.
As you can see, text appears on the left and images
will appear in the bottom left of the slide.

![title-for-plotly-image](https://plot.ly/~rgerstenberger/0)

---
## Slide 2: Text, Images and CodePane (##)

We also can include some code in any language that you want.
Just be sure to specify it in your markdown string.

![title-here](https://images-na.ssl-images-amazon.com/images/G/01/img15/pet-products/small-tiles/23695_pets_vertical_store_dogs_small_tile_8._CB312176604_.jpg)


```javascript
i = 2 + 2
print("hello world");
` ```

---
background-image: url(http://wallpaper-gallery.net/images/light-blue-wallpaper/light-blue-wallpaper-19.jpg)

### Slide 3: Background Picture (###)
There is another chart in this slide,
with a nice blue background from one of the
older iMac Default Desktop Backgrounds

![title-here](https://plot.ly/~chris/1638/)

"""
my_pres = pres.Presentation(markdown_string)
py.presentation_ops.upload(my_pres, 'my first presentation with api')

and the presentation is live here

General Rules for the Syntax:

works like markdown
--- denotes a new slide
placing remark slide properties before the header (eg. '# the title') will treat them different and execute them according to what they do.
title-here will insert the image/plotly plot at url. (text in [...] doesn't do anything now)

Points for Improvement/Discussion:

I'm debating whether we should stick pretty closely to the remark syntax. It uses .left[...] to denote aligning text or images but this is pretty annoying to program. Could there be a better way to let the user choose where a text block or an image is going to end up on a slide or should we just let the user pick from a selection of themes, as Jack mentioned above?

Personally, I'd like both: to be able to customize where the boxes are going to go in the layout, and if not specified they can default to one of a few themes.

Maybe something like .left[some text here, (15, 30)] would be okay, as it puts all the power of determining the exact coordinates in the users' hands.

Thoughts?
@jackparmer @chriddyp

Holding off on tests until we have a solid gameplan for the final design. 🏈

jackparmer · 2017-05-04T04:05:29Z

.left[some text here, (15, 30)]

Could this be either pixels or a percent-from-left?

As a test, I'd love to see how close we could get to this presentation using the markdown syntax:

https://plot.ly/~jackp/17179

As another test, maybe one of these slide decks from @cpsievert that used http://rmarkdown.rstudio.com/ioslides_presentation_format.html?

http://cpsievert.github.io/talks/

Kully · 2017-05-04T04:15:54Z

As a test, I'd love to see how close we could get to this presentation using the markdown syntax:

Yes! Yes! on it! 👍

Kully · 2017-05-04T04:18:16Z

Could this be either pixels or a percent-from-left?

I like percent over pixels.
So perhaps something like:

.14fromleft[
some text here
]

Kully · 2017-05-11T19:58:26Z

Here's my suggestion for how we treat the presentations:

For a first pass, we should force all text, codepanes, images, and plotly charts (except for headers that start with #, ##, ###, ####) to start with the following syntactical bit:

.left45top12[all of your text goes here]

where the alignment command is read like "place 45% from left, 12% from top".

I think this offers a lot of customizable options, even though it's not identical to the remark format.

Thoughts? @chriddyp @jackparmer @cpsievert

jackparmer · 2017-05-11T20:57:38Z

👍 sounds find to me. Thanks Adam!

…

On Thu, May 11, 2017 at 12:58 PM, Adam Kulidjian ***@***.***> wrote: Here's my suggestion for how we treat the presentations: For a first pass, we should force all text, codepanes, images, and plotly charts (except for headers that start with #, ##, ###, ####) to start with the following syntactical bit: .left45top12[all of your text goes here] where the alignment command is read like "place 45% from left, 12% from top". I think this offers a lot of customizable options, even though it's not identical to the remark format. Thoughts? @chriddyp <https://github.com/chriddyp> @jackparmer <https://github.com/jackparmer> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#739 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABx4al6Pg6LvWYo2g3tE-nQO63OpI4RPks5r42hkgaJpZM4NFePJ> .

Kully · 2017-05-11T20:59:06Z

sounds find to me. Thanks Adam!

We should be able to replicate those other presentations you linked me

cldougl · 2017-10-20T21:09:55Z

CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).

+## [2.1.1] - 2017-10-20


I think we'll make this 2.2.0 based on adding new features: #852 (comment)

chriddyp · 2017-10-23T16:40:53Z

plotly/plotly/plotly.py

+
+        :param (dict) presentation: the JSON presentation to be uploaded. Use
+            plotly.presentation_objs.Presentation to create the presentation
+            from a string.


I don't quite understand what "from a string" means here

What I mean is that you are defining a variable as a string and passing that into the presentations function to generate the JSON

OK. Maybe "... to create presentations from a Markdown-like string"?

chriddyp · 2017-10-23T16:56:23Z

plotly/plotly/plotly.py

+        :param (str) sharing: can be set to either 'public', 'private'
+            or 'secret'. If 'public', your presentation will be viewable by
+            all other users. If 'private' only you can see your presentation.
+            If 'secret', the url will be returned with a sharekey appended


I'm not sure if folks outside of Plotly will know what "sharekey" is. Could this be: "The url will contain a random, hard-to-guess string appended to it. Anyone with the url may view the presentation."

How about i keep the word "sharekey" but explain what it is? I've used the term in dashboard_ops function as well and I think it's a good term for people to know

Sure. What do you propose?

How about: If it is set to 'secret', the url will be returned with a string of random characters appended to the url which is called a sharekey. The point of a sharekey is that it makes the url very hard to guess, but anyone with the url can view the presentation.

chriddyp · 2017-10-23T16:57:35Z

plotly/plotly/plotly.py

+            world_readable = False
+        elif sharing == 'secret':
+            world_readable = False
+


like in other wrappers, we should raise an exception if sharing wasn't one of those strings

chriddyp · 2017-10-23T16:58:39Z

plotly/plotly/plotly.py

+        # lookup if pre-existing filename already exists
+        try:
+            lookup_res = v2.files.lookup(filename)
+            matching_file = json.loads(lookup_res.content)


missing a lookup_res.raise_for_status()?

chriddyp · 2017-10-23T17:01:21Z

plotly/presentation_objs/presentation_objs.py

+    'Bold': {'fontWeight': 700},
+    'Bold Italic': {'fontWeight': 700, 'fontStyle': 'italic'},
+    'Black': {'fontWeight': 900},
+    'Black Italic': {'fontWeight': 900, 'fontStyle': 'italic'},


Maybe this should be "Very Bold"? Bold doesn't necessarily mean black

These are based on the naming conventions in the app itself, so I think we should keep them consistent with the pres app

chriddyp · 2017-10-23T17:06:50Z

plotly/presentation_objs/presentation_objs.py

+
+    elif boxtype == 'Image':
+        props = {
+            'height': 512,


could you comment where 512 came from?

How's this:

# the default height, width for an Image are # both set to 512

chriddyp · 2017-10-23T17:07:26Z

plotly/presentation_objs/presentation_objs.py

+        props = {
+            'frameBorder': 0,
+            'scrolling': 'no',
+            'src': text_or_url + '.embed?link=false',


is this missing sharekey?

it's not, but the embed line should not be there if there is a sharekey - I just tested that

now it checks if ?sharekey is in the url and will not put the .embed?link=false if that is true

Even with a sharekey it should still have .embed and link=false, it will just look something like:

.embed?link=false&sharekey=....

vs just

.embed?link=false

chriddyp · 2017-10-23T17:09:55Z

plotly/presentation_objs/presentation_objs.py

+    "'left', 'top', 'width', and 'height' parameters must be "
+    "set equal to a number (percentage) or a number with "
+    "'px' at the end of it. For example in "
+    "\n\n.left=10;top=50px{{TEXT}}\n\n the top left corner of "


What's {{TEXT}} mean here?

I just deleted that message. It's nested in a hidden function so we shouldn't have it at all

Could you run flake8 on this file? That'll catch unused variables like this.

flake8 didn't catch unused variables but pylint did 👍

chriddyp · 2017-10-23T17:11:18Z

plotly/presentation_objs/presentation_objs.py

+    while line.endswith('\n') or line.endswith(' '):
+        line = line[: -1]
+    return line
+


what if there are more than 1 white spaces? test

lstrip might be a more robust solution here: https://docs.python.org/3/library/stdtypes.html#str.lstrip

excellent reference! I didn't know about this

chriddyp · 2017-10-23T18:44:00Z

plotly/presentation_objs/presentation_objs.py

+        markdown_string += '\n---\n'
+
+    text_blocks = re.split(
+        '\n--\n|\n---\n|\n----\n|\n-----\n|\n------\n', markdown_string


Would a regex like \n-{2,}\n be more generic? Check out https://regex101.com/ for testing regexes

chriddyp · 2017-10-23T18:45:59Z

plotly/presentation_objs/presentation_objs.py

+    )
+    list_of_slides = []
+    for j, text in enumerate(text_blocks):
+        if not all(char in ['\n', '-', ' '] for char in text):


What is this line doing? It seems like it's trying to reject strings like \n---\n that are used as separators?

chriddyp · 2017-10-23T18:49:08Z

plotly/presentation_objs/presentation_objs.py

+        l_brace_idx = slide_copy[left_idx:].find('{{') + left_idx
+        properties = slide_copy[left_idx + 1: l_brace_idx].split(
+            prop_split
+        )


could you add some comments that describe what this function and this loop is doing?

this is a unused function - deleting

chriddyp · 2017-10-23T18:50:18Z

plotly/presentation_objs/presentation_objs.py

+
+def _top_spec_for_text_at_bottom(text_block, width_per, per_from_bottom=0,
+                                 min_top=30):
+    # TODO: customize this function for different fonts/sizes


some comments that describe what this function does (inputs and outputs) would be really helpful

chriddyp · 2017-10-23T18:54:45Z

plotly/presentation_objs/presentation_objs.py

+                            raise exceptions.PlotlyError(
+                                "You are attempting to insert a Plotly Chart "
+                                "in your slide but your url does not have "
+                                "plot.ly in it."


if the user is using plotly on-premise, then this URL won't necessarily have plot.ly in it. It could be like plotly.acme.com

chriddyp · 2017-10-23T18:57:02Z

plotly/tests/test_core/test_spectacle_presentation/test_spectacle_presentation.py

+            "Notice how the language that you want the code to be "
+            "displayed in is immediately to the right of first "
+            "entering '```', i.e. '```python'."
+        )


instead of hardcoding these messages, could you import them from the original file? That way, if we wanted to change these messages, we would only have to do it from one place

chriddyp · 2017-10-23T18:59:17Z

plotly/tests/test_core/test_spectacle_presentation/test_spectacle_presentation.py

+        self.assertEqual(
+            my_pres['presentation']['slides'][0]['children'][0]['props'],
+            exp_pres['presentation']['slides'][0]['children'][0]['props']
+        )


these tests are pretty light- it looks like there is just one test that for a simple presentation, doesn't include Plotly, Image, multiple slides, or any of the different layout options. Could you try to come up with a few more tests that test these different options?

sure
my reason for making it so light was that the JSON blobs are so large anyways
but I agree we should be testing the other features too

Kully · 2017-10-25T23:09:27Z

@chriddyp Okay, all DONE! 🎉
It's set for Plotly 2.2.0 fyi.

chriddyp · 2017-10-26T17:18:35Z

thanks for making those changes! 💃 from me

Kully added 4 commits March 21, 2017 17:06

spectacle presentations v2 added

1bdbd00

added presentation folder w/ init file

0f9a68c

start working on __init__ and main presentation_objs file

1bb5ec0

add some templates to the file

f696f5a

Kully added 2 commits May 3, 2017 15:28

functional presentation_objs class and tools for uploading in plotly.…

6b7a24b

…plotly (ops class)

Merge branch 'master' into presentations-wrapper

43d6dfb

Kully requested review from theengineear and removed request for theengineear May 3, 2017 20:08

Kully added 14 commits May 22, 2017 11:47

fully working

9f9e419

fixed language typo

867a5ea

a pull

de91e8c

committed

16fca75

fully functional presentation wrapper

c590166

starting an easier approach

810458c

more work

787fa47

pres work

a860bf5

added tiling on left and right

1682e84

USE NON SIMPLE CODE FROM HERE

f8e8d25

fixed tiled bug

8988984

stuff

9db2ae0

remove print text_lines

4032836

merge conflicts for pres-wrapper file

1f3c65a

cldougl reviewed Oct 23, 2017

View reviewed changes

chriddyp reviewed Oct 23, 2017

View reviewed changes

Kully added 8 commits October 24, 2017 11:44

part of chris' comments

c8d731e

comment style out - minor

1a72c5a

more commenting out

52117e5

commenting again

fad18aa

bug fixed - added position:absolute in text styles

d38fbf3

more chris comments and change middle 3 slide title 'top' pos

db1a9ff

all tests but final are ready

abb4178

finished tests and added comment for 512 height, width defaults

43ae1d0

make default schema

f9424c2

Kully merged commit 7c1adde into master Oct 26, 2017

Kully deleted the presentations-wrapper branch October 26, 2017 17:18

Presentations wrapper #739

Presentations wrapper #739

Conversation

Kully commented Apr 23, 2017

Kully commented Apr 23, 2017

Kully commented May 3, 2017 • edited Loading

General Rules for the Syntax:

Points for Improvement/Discussion:

jackparmer commented May 4, 2017

Kully commented May 4, 2017

Kully commented May 4, 2017 • edited Loading

Kully commented May 11, 2017 • edited Loading

jackparmer commented May 11, 2017 via email

Kully commented May 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chriddyp Oct 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kully commented Oct 25, 2017 • edited Loading

chriddyp commented Oct 26, 2017

Kully commented May 3, 2017 •

edited

Loading

Kully commented May 4, 2017 •

edited

Loading

Kully commented May 11, 2017 •

edited

Loading

chriddyp Oct 23, 2017 •

edited

Loading

Kully commented Oct 25, 2017 •

edited

Loading