docs/docs/contributing.md

title: Tableau Document API

email: github@tableau.com

description: Programmatically update your Tableau workbooks and data sources.

baseurl: "/document-api-python"

permalinks: pretty

<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/document-api-python/edit/master/docs/{{ page.path }}" class="edit-links"><span class="glyphicon glyphicon-pencil"></span> Edit this page</a>

&nbsp;

<a href="https://github.com/tableau/document-api-python/issues" class="edit-links"><span class="glyphicon glyphicon-flag"></span> Submit an issue</a>

</div>

title: Contributing

layout: docs

We welcome contributions to this project!

layout: docs

<<<<<<< 6ee666bf06d5ab59931100b3955779c35693e33f

1. Make sure you have [signed the CLA](http://tableau.github.io/#contributor-license-agreement-cla)

1. Fork the repository.

We follow the "Fork and Pull" model as described [here](https://help.github.com/articles/about-collaborative-development-models/).

1. Clone your fork:

```shell

git clone http://github.com/<your_username>/document-api-python

```

1. Run the tests to make sure everything is peachy:

```shell

python setup.py test

```

1. Set up the feature, fix, or documentation branch.

It is recommended to use the format issue#-type-description (e.g. 13-fix-connection-bug) like so:

```shell

git checkout -b 13-feature-new-stuff

```

1. Code and commit!

Here's a quick checklist for ensuring a good pull request:

- Only touch the minimal amount of files possible while still accomplishing the goal.

- Ensure all indentation is done as 4-spaces and your editor is set to unix line endings.

- The code matches PEP8 style guides. If you cloned the repo you can run `pycodestyle .`

- Keep commit messages clean and descriptive.

If the PR is accepted it will get 'Squashed' into a single commit before merging, the commit messages will be used to generate the Merge commit message.

All of our tests live under the `test/` folder in the repository.

We use `unittest` and the built-in test runner `python setup.py test`.

If a test needs a static file, like a twb/twbx, it should live under `test/assets/`

1. Update the documentation.

When adding a new feature or improving existing functionality we may ask that you update the documentation along with your code.

If you are just making a PR for documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built in `Edit this file` in the Github UI

1. Submit to your fork.

1. Make a PR as described [here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the 'development' branch.

1. Wait for a review and address any feedback.

While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely pinging the PR after a few days with no response is OK, we'll try and respond with a timeline as soon as we are able.

1. That's it! When the PR has received :rocket:'s from members of the core team they will merge the PR

setup(

name='tableaudocumentapi',

version='0.5',

author='Tableau',

author_email='github@tableau.com',

url='https://github.com/tableau/document-api-python',

self._username = connxml.get('username')

self._authentication = connxml.get('authentication')

self._class = connxml.get('class')

self._port = connxml.get('port', None)

def __repr__(self):

return "'<Connection server='{}' dbname='{}' @ {}>'".format(self._server, self._dbname, hex(id(self)))

@classmethod

def from_attributes(cls, server, dbname, username, dbclass, port=None, authentication=''):

root = ET.Element('connection', authentication=authentication)

xml = cls(root)

xml.server = server

xml.dbname = dbname

xml.username = username

xml.dbclass = dbclass

xml.port = port

return xml

self._class = value

self._connectionXML.set('class', value)

###########

# port

###########

@property

def port(self):

return self._port

@port.setter

def port(self, value):

self._port = value

# If port is None we remove the element and don't write it to XML

if value is None:

try:

del self._connectionXML.attrib['port']

except KeyError:

pass

else:

self._connectionXML.set('port', value)

self._name = self._datasourceXML.get('name') or self._datasourceXML.get(

'formatted-name') # TDS files don't have a name attribute

self._version = self._datasourceXML.get('version')

self._caption = self._datasourceXML.get('caption', '')

self._connection_parser = ConnectionParser(

self._datasourceXML, version=self._version)

self._connections = self._connection_parser.get_connections()

def version(self):

return self._version

@property

def caption(self):

return self._caption

@caption.setter

def caption(self, value):

self._datasourceXML.set('caption', value)

self._caption = value

@caption.deleter

def caption(self):

del self._datasourceXML.attrib['caption']

self._caption = ''

###########

# connections

###########