Initial documentation for TSC #98

jdomingu · 2016-11-03T02:14:23Z

No description provided.

t8y8 · 2016-11-03T05:59:36Z

Few quick notes before I dive into the text details:

When we do eventually merge, please use 'Squash and Merge' so there's a single commit in the history
Check w/ @RussTheAerialist on the direct to master thing -- he and I experienced some pains today around this

t8y8

🚀
Lots of minor comments, I don't think any are necessarily blocking, but please consider them all. Especially some comments I have around what's really necessary to document and some things that are kinda mis-truths

t8y8 · 2016-11-03T06:04:03Z

docs/_layouts/docs.html

+        <div class="content .col-xs-12 .col-sm-8 .col-md-9">
+            <h1>{{ page.title }}</h1>
+            <div class="edit-container">
+                <a href="https://github.com/tableau/server-client-python/edit/master/docs/docs/{{ page.path }}" class="edit-links"><span class="glyphicon glyphicon-pencil"></span> Edit this page</a>


is it docs/docs/ {{path}} I think in document-api it's just docs/{{path}

Nice catch. Copypasta problem :) Should be fixed.

t8y8 · 2016-11-03T06:05:04Z

docs/docs/api-ref.md

+---
+
+<div class="alert alert-info">
+    <b>Important:</b> More coming soon! This section is under active construction and might not reflect all the available functionality of the TSC library.


in the TSC library?? Maybe or. I think in :)

t8y8 · 2016-11-03T06:06:06Z

docs/docs/api-ref.md

+
+### Create Site
+
+Creates a new site for the given site item object.


Big meta-question: Do we want to call them Item Objects, or just Objects? I vote latter. I know we call them SiteItem in the API but item object sounds redundant

I'll follow up with you all on this post-TC. I expect I'll be reworking all the API ref stuff.

t8y8 · 2016-11-03T06:07:14Z

docs/docs/api-ref.md

+Gets all the sites on the server.
+
+```py
+Sites.get()


Not quite, get's 100 sites by default, or up to 1000 sites at a time.

Yup. Good call--I've added in that you need to use the pager.

t8y8 · 2016-11-03T06:09:08Z

docs/docs/api-ref.md

+Example:
+
+```py
+new_project = TSC.ProjectItem(name='Test Project', description='Project created for testing')


Why not set it when instantiating like name and description?

I pulled in most of the examples from the test suite in the interest of time--I expect I'll be rewriting more cogent examples afterward. :(

t8y8 · 2016-11-03T06:27:27Z

docs/docs/samples.md

+
+* `create_group.py`. Create a user group.
+
+* `create_schedules.py`. Create scheduled extract refresh tasks and subscription tasks.


This creates schedules, not tasks (currently)

t8y8 · 2016-11-03T06:27:42Z

docs/docs/samples.md

+
+* `create_schedules.py`. Create scheduled extract refresh tasks and subscription tasks.
+
+* `explore_datasource.py`. Queries all datasources, selects a datasource, populates connections for the datasource, then updates the datasource.


Actualllllly, no, doesn't get them all, doesn't use Pager

t8y8 · 2016-11-03T06:27:47Z

docs/docs/samples.md

+
+* `explore_datasource.py`. Queries all datasources, selects a datasource, populates connections for the datasource, then updates the datasource.
+
+* `explore_workbook.py`. Queries all workbooks, selects a workbook, populates the connections and views for a workbook, then updates the workbook.


t8y8 · 2016-11-03T06:28:47Z

docs/docs/sign-in-out.md

+
+This code does the following things:
+
+* Creates an authentication object that stores your user name and password.


Honest question: Does anyone care that it does all these things?

sign_in signs you in, sign_out signs you out.

You might want to note that it's a normal session, so it's got a time limit (2 hours, 4 hours, I forget)

Sounds good. Added a note about session length and cut the details.

t8y8 · 2016-11-03T06:30:08Z

docs/docs/versions.md

+
+server = TSC.Server('http://SERVER_URL')
+
+print(server.version)


It's always 2.3 by default, unless you change it to 2.4.

We don't auto detect or anything like that, so running code to discover this feels unnecessary

I think we need to leave this in. Yes, it's hardcoded to 2.3 right now, but how would you know that if you ran pip install? You'd have to look at the source or run this command. This will be more useful when we have multiple releases as well.

Not sure how you installed the library matters, this is about the Server API version not the library's version.

I just filed #99 that would make this example useful, it's fine to leave it in, but I think you should also just have the note for now that it defaults to 2.3?

jdomingu · 2016-11-03T19:39:55Z

@RussTheAerialist Tyler mentioned that pushing direct to master caused some problems earlier? Any concerns I should now about?

graysonarts · 2016-11-03T19:45:02Z

It's better to do it against development, but since we just took development into master, I think right now the two branches are effectively the same, so if we get this checked in before EOD Friday, I can just pull this into development immediately.

it's only a hassle when development has a bunch of changes in it that aren't in master

jdomingu · 2016-11-03T20:35:25Z

@RussTheAerialist Thanks for the explanation. I'll keep that in mind next time for sure.

* First cut at API docs * Update jquery version for bootstrap compatibility * Incorporate review feedback * Add pagination docs * Add dev guide * Add docs for populating views and connections * Continue adding to api ref * Edits for existing content * Update readme to point to docs * Incorporate edits from PR

jdomingu added 9 commits November 2, 2016 02:36

First cut at API docs

91692e7

Update jquery version for bootstrap compatibility

4d15bda

Incorporate review feedback

b0d1eaf

Add pagination docs

848cf57

Add dev guide

cb0366e

Add docs for populating views and connections

8ed38d1

Continue adding to api ref

337eb16

Edits for existing content

fad80a5

Update readme to point to docs

1fa9339

t8y8 approved these changes Nov 3, 2016

View reviewed changes

Incorporate edits from PR

2875806

graysonarts approved these changes Nov 3, 2016

View reviewed changes

jdomingu merged commit c4ed22e into tableau:master Nov 3, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial documentation for TSC #98

Initial documentation for TSC #98

jdomingu commented Nov 3, 2016

t8y8 commented Nov 3, 2016

t8y8 left a comment

t8y8 Nov 3, 2016

jdomingu Nov 3, 2016

t8y8 Nov 3, 2016

t8y8 Nov 3, 2016

jdomingu Nov 3, 2016

t8y8 Nov 3, 2016

jdomingu Nov 3, 2016

t8y8 Nov 3, 2016

jdomingu Nov 3, 2016

t8y8 Nov 3, 2016

t8y8 Nov 3, 2016

t8y8 Nov 3, 2016

t8y8 Nov 3, 2016

jdomingu Nov 3, 2016

t8y8 Nov 3, 2016

jdomingu Nov 3, 2016

t8y8 Nov 3, 2016 •

edited

jdomingu commented Nov 3, 2016

graysonarts commented Nov 3, 2016

jdomingu commented Nov 3, 2016


		### Create Site

		Creates a new site for the given site item object.


		* `create_group.py`. Create a user group.

		* `create_schedules.py`. Create scheduled extract refresh tasks and subscription tasks.


		* `create_schedules.py`. Create scheduled extract refresh tasks and subscription tasks.

		* `explore_datasource.py`. Queries all datasources, selects a datasource, populates connections for the datasource, then updates the datasource.


		* `explore_datasource.py`. Queries all datasources, selects a datasource, populates connections for the datasource, then updates the datasource.

		* `explore_workbook.py`. Queries all workbooks, selects a workbook, populates the connections and views for a workbook, then updates the workbook.


		This code does the following things:

		* Creates an authentication object that stores your user name and password.


		server = TSC.Server('http://SERVER_URL')

		print(server.version)

Initial documentation for TSC #98

Initial documentation for TSC #98

Conversation

jdomingu commented Nov 3, 2016

t8y8 commented Nov 3, 2016

t8y8 left a 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

t8y8 Nov 3, 2016 • edited

Choose a reason for hiding this comment

jdomingu commented Nov 3, 2016

graysonarts commented Nov 3, 2016

jdomingu commented Nov 3, 2016

t8y8 Nov 3, 2016 •

edited