# TABASSIST
## What's is about
This package has aim to assist you while you work with Tableau and takes some routine from your shoulders.
## INSTALATION
```console
pip install tabassist
```
## USAGE
```console
// Check Tableau workbook for errors
$ tabassist check --file "/Users/user_name/Tableau_workbook.twbx"
T100: 'check_NOT_in_lowercase' field not in lowercase
T101: ' check_trailing_whitespace' field has trailing whitespace
T101: 'check_trailing_whitespace ' field has trailing whitespace
T102: 'check_non_unique_name (copy)' field has non allowed symbol(s)
T102: 'check_non_allowed_символы' field has non allowed symbol(s)
T103: 'check_non_unique_name (copy)' field has '(copy)' as a part of name
T104: 'check_comment_doesnt_exist' field doesn’t have comment
T105: 'check_comment_position' field has inline comment which doesn’t start from first line
T106: 'id' field doesn’t used by any worksheet
T106: 'check_unused_by_worksheet' field doesn’t used by any worksheet
T106: 'city' field doesn’t used by any worksheet
```
```console
// Export documentation of Tableau workbook
$ tabassist doc export --file "/Users/user_name/Tableau_workbook.twbx" --name documentaion.md
Document exported to '/Users/user_name/'.
```
<details><summary>documentaion.md</summary>
>## Описание дашборда
>to be updated...
>
>## Кто пользуется дашбордом
>to be updated...
>
>## Частота обновления
>to be updated...
>
>## MOCK_DATA
>
>### Местонахождение
>
>
>Сервер -
>Тип БД - textscan
>База данных - None
>Порт - None
>
>
>
>### Описание полей
>
>| Наименование | Описание | Формула |
>| ------ | ------ | ------ |
>id | |None
>first_name | |None
>last_name | |None
>email | |None
>gender | |None
>ip_address | |None
>birth_date | |None
>order_date | |None
>city | |None
>city | |None
>id | |None
>ages | | // age of fake client<br/>DATEDIFF('year', [birth_date], >TODAY())
>check_NOT_in_lowercase | | // check field name in lowercase<br/>'fake'
>check_non_unique_name (copy) | | // check stop words<br/>'fake'
>check_non_allowed_символы | | // check non allowed symbols<br/>'fake'
>check_comment_doesnt_exist | | 'fake'
>check_unused_by_worksheet | | // check field is unused<br/>'fake'
>check_trailing_whitespace | | // check field name for containing >whitespace after<br/>'fake'
>check_comment_exist | | // check commect exist<br/>'fake'
>check_comment_position | | 'fake'<br/>// check comment starts from first&>ensp;line
> check_trailing_whitespace | | // check field name for containing >whitespace before<br/>'fake'
>first_name | |None
>last_name | |None
>email | |None
>gender | |None
>ip_address | |None
>birth_date | |None
>order_date | |None
>
>
>## Known issues and workaround
>
>not found yet.
</details>
## DEVELOPMENT
1. virtualenv env
2. source ./env/bin/activate
3. pip install -r requarements.txt
4. (OPTIONAL)
- pip install pycodestyle
- pip install pydocstyle
- pip install pytest
Raw data
{
"_id": null,
"home_page": "https://github.com/dev-mkc19/tabassist",
"name": "tabassist",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "tableau cli-app",
"author": "Mikhail Korotchenkov",
"author_email": "mr.mkc19@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/b1/e4/2147aa9ed451f18524a9e254bb02cfd08fcf7d37a4d46b21eb10d75f45b9/tabassist-0.2.2.tar.gz",
"platform": "any",
"description": "# TABASSIST\n\n## What's is about\n\nThis package has aim to assist you while you work with Tableau and takes some routine from your shoulders.\n\n## INSTALATION\n\n```console\npip install tabassist\n```\n\n## USAGE\n\n```console\n// Check Tableau workbook for errors\n$ tabassist check --file \"/Users/user_name/Tableau_workbook.twbx\"\n\nT100: 'check_NOT_in_lowercase' field not in lowercase\nT101: ' check_trailing_whitespace' field has trailing whitespace\nT101: 'check_trailing_whitespace ' field has trailing whitespace\nT102: 'check_non_unique_name (copy)' field has non allowed symbol(s)\nT102: 'check_non_allowed_\u0441\u0438\u043c\u0432\u043e\u043b\u044b' field has non allowed symbol(s)\nT103: 'check_non_unique_name (copy)' field has '(copy)' as a part of name\nT104: 'check_comment_doesnt_exist' field doesn\u2019t have comment\nT105: 'check_comment_position' field has inline comment which doesn\u2019t start from first line\nT106: 'id' field doesn\u2019t used by any worksheet\nT106: 'check_unused_by_worksheet' field doesn\u2019t used by any worksheet\nT106: 'city' field doesn\u2019t used by any worksheet\n```\n\n```console\n// Export documentation of Tableau workbook\n$ tabassist doc export --file \"/Users/user_name/Tableau_workbook.twbx\" --name documentaion.md\nDocument exported to '/Users/user_name/'.\n```\n<details><summary>documentaion.md</summary>\n\n>## \u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 \u0434\u0430\u0448\u0431\u043e\u0440\u0434\u0430\n>to be updated...\n>\n>## \u041a\u0442\u043e \u043f\u043e\u043b\u044c\u0437\u0443\u0435\u0442\u0441\u044f \u0434\u0430\u0448\u0431\u043e\u0440\u0434\u043e\u043c \n>to be updated...\n>\n>## \u0427\u0430\u0441\u0442\u043e\u0442\u0430 \u043e\u0431\u043d\u043e\u0432\u043b\u0435\u043d\u0438\u044f \n>to be updated...\n>\n>## MOCK_DATA\n>\n>### \u041c\u0435\u0441\u0442\u043e\u043d\u0430\u0445\u043e\u0436\u0434\u0435\u043d\u0438\u0435\n>\n>\n>\u0421\u0435\u0440\u0432\u0435\u0440 - \n>\u0422\u0438\u043f \u0411\u0414 - textscan \n>\u0411\u0430\u0437\u0430 \u0434\u0430\u043d\u043d\u044b\u0445 - None \n>\u041f\u043e\u0440\u0442 - None \n>\n>\n>\n>### \u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 \u043f\u043e\u043b\u0435\u0439\n>\n>| \u041d\u0430\u0438\u043c\u0435\u043d\u043e\u0432\u0430\u043d\u0438\u0435 | \u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 | \u0424\u043e\u0440\u043c\u0443\u043b\u0430 |\n>| ------ | ------ | ------ |\n>id | |None\n>first_name | |None\n>last_name | |None\n>email | |None\n>gender | |None\n>ip_address | |None\n>birth_date | |None\n>order_date | |None\n>city | |None\n>city | |None\n>id | |None\n>ages | | // age of fake client<br/>DATEDIFF('year', [birth_date], >TODAY())\n>check_NOT_in_lowercase | | // check field name in lowercase<br/>'fake'\n>check_non_unique_name (copy) | | // check stop words<br/>'fake'\n>check_non_allowed_\u0441\u0438\u043c\u0432\u043e\u043b\u044b | | // check non allowed symbols<br/>'fake'\n>check_comment_doesnt_exist | | 'fake'\n>check_unused_by_worksheet | | // check field is unused<br/>'fake'\n>check_trailing_whitespace | | // check field name for containing >whitespace after<br/>'fake'\n>check_comment_exist | | // check commect exist<br/>'fake'\n>check_comment_position | | 'fake'<br/>// check comment starts from first&>ensp;line\n> check_trailing_whitespace | | // check field name for containing >whitespace before<br/>'fake'\n>first_name | |None\n>last_name | |None\n>email | |None\n>gender | |None\n>ip_address | |None\n>birth_date | |None\n>order_date | |None\n>\n>\n>## Known issues and workaround\n>\n>not found yet.\n</details>\n\n## DEVELOPMENT\n\n1. virtualenv env\n2. source ./env/bin/activate\n3. pip install -r requarements.txt\n4. (OPTIONAL)\n\n - pip install pycodestyle\n - pip install pydocstyle\n - pip install pytest\n",
"bugtrack_url": null,
"license": "",
"summary": "Command line utility to work with Tableau workbook faster.",
"version": "0.2.2",
"split_keywords": [
"tableau",
"cli-app"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "5eb1e33abee9e2da9dbe9f7708d72433",
"sha256": "9762669a6c1a46d064e6c7779e5a0c834462e2ca422d6434400c3bf99fb8f041"
},
"downloads": -1,
"filename": "tabassist-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5eb1e33abee9e2da9dbe9f7708d72433",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10573,
"upload_time": "2022-12-25T05:03:57",
"upload_time_iso_8601": "2022-12-25T05:03:57.924897Z",
"url": "https://files.pythonhosted.org/packages/bb/94/5e586a75f22b752d6d40b4fd712fcbbbec4abc0aa0541ef814eaeddaf743/tabassist-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "5e5cb1db09cdac17dacfcc64bd483f84",
"sha256": "1932b301e5ed7ed069a60d656ceefd9771e87c4f3c5b98d978d2528455c91468"
},
"downloads": -1,
"filename": "tabassist-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "5e5cb1db09cdac17dacfcc64bd483f84",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9078,
"upload_time": "2022-12-25T05:03:59",
"upload_time_iso_8601": "2022-12-25T05:03:59.148927Z",
"url": "https://files.pythonhosted.org/packages/b1/e4/2147aa9ed451f18524a9e254bb02cfd08fcf7d37a4d46b21eb10d75f45b9/tabassist-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-25 05:03:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "dev-mkc19",
"github_project": "tabassist",
"lcname": "tabassist"
}
JSON
