Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ We don't yet support creating files from scratch. In addition, support for `.twb
###Getting Started
To use this SDK, you must have Python installed. You can use either 2.7.X or 3.3 and later.

#### Installing the latest stable version (preferred)

```text
pip install tableaudocumentapi
```

#### Installing From Source

Download the `.zip` file that contains the SDK. Unzip the file and then run the following command:

```text
Expand Down
9 changes: 9 additions & 0 deletions publish.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/usr/bin/env bash
Copy link
Contributor

@t8y8 t8y8 Jun 29, 2016

Choose a reason for hiding this comment

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

This won't work for a standard Windows world -- maybe that's ok but there are some cross platform options if we want to start adding build/test/doc scripts. A lot of projects use http://www.pyinvoke.org/ which is a rake-like system.

Not blocking, just a thought

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point @t8y8 though I'm hesitant to take a dependency on an external module just for making our job of pushing to pypi easier.
Eventually, I'd like to automate publishing to pypi when we create the release tag.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, we probably won't hit the inflection point of needing something like that for a while.

Changes LGTM


set -e

rm -rf dist
python setup.py sdist
python setup.py bdist_wheel
python3 setup.py bdist_wheel
twine upload dist/*
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
author='Tableau Software',
author_email='[email protected]',
url='https://github.com/tableau/document-api-python',
py_modules=['tableaudocumentapi'],
packages=['tableaudocumentapi'],
license='MIT',
description='A Python module for working with Tableau files.',
test_suite='test'
Expand Down