Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation improvements #385

Merged
merged 7 commits into from Dec 24, 2019
Merged

Documentation improvements #385

merged 7 commits into from Dec 24, 2019

Conversation

0golovatyi
Copy link
Contributor

  • Update outdated documentation with the links to the latest Tableau pages.

  • Use docopt instead of argparser for command line parameters for tabpy and tabpy-user.

  • Remove .travis.yml - TabPy uses github actions now.

@0golovatyi 0golovatyi self-assigned this Dec 21, 2019
@pep8speaks
Copy link

pep8speaks commented Dec 21, 2019 •
edited

Hello @0golovatyi! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 7:89: E501 line too long (95 > 88 characters)
Line 8:89: E501 line too long (98 > 88 characters)

Comment last updated at 2019-12-21 01:48:26 UTC

johng42
johng42 reviewed Dec 21, 2019
View reviewed changes
.github/workflows/test_coveralls_codestyle.yml
@@ -1,6 +1,6 @@
name: CI

on: [push, pull_request]
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the reason for this removal?
According to the docs, both of these are needed for coveralls to run on pull requests. https://github.com/coverallsapp/github-action/
which isn't intuitive, admittedly...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As you can see below the build still runs. I removed the push to remove duplication of the jobs. In theory, we may have different workflows of push and PR (e.g. only check code style on push) in future. And for now, there's no need to run the workflow twice.

@0golovatyi 0golovatyi merged commit fbf8f31 into dev Dec 24, 2019
@0golovatyi 0golovatyi deleted the dev_improvements branch December 24, 2019 22:18
0golovatyi added a commit that referenced this pull request Jan 14, 2020
@0golovatyi @sbabayan @phantomcosmonaut
v0.8.10 (#388)
38fde42 
* added anvoa to supported pre-deployed models in tabpy (#350)

* added anvoa to supported pre-deployed models in tabpy

* fixed pep8 issue

* fixed md

* Add Ctrl+C handler (#348)

* Add Ctrl+C handler

* Fix unit tests warnings for genson

* Add test to increase code coverage

* Add

* Change default from 10Mb to 100Mb for request size

* Increase code coverage

* Increase code coverage

* Convert buffer size to int

* Add Ctrl+C test

* Delete test added to the wrong folder

* Update CHANGELOG

* Update test_app.py

* Remove dead code

* Don't count coverage for multiline expressions

* Add test case for invalid protocol

* Add test case for _check_endpoint_name

* Remove dead code

* Fix vulnerabilities found by LGTM (#361)

* Fix vulnerabilities found by LGTM

* Fix test failures

* Dev improvements (#384)

* Fix flake8 warnings

* Merge from master

* Fix pycodestyle

* Fix more flake8 warnings

* Fix tests to pass again

* Create test_coveralls_codestyle.yml (#382)

* Use github actions

* Documentation improvements (#385)

* Delete .travis.yml

* Fix Ctrl+C failing on extra parameter in signal handler

* Remove outdated documentation for how to configure connection

* tabpy.py to use docopt

* Update tabpy-user with docopt

* Update CHANGELOG

* Fix code style

* Change regex, add remove method, and edit qeury_timeout (#375)

* Added Client.remove method to delete deployed model

* Fix bug for query_timeout types

* Update CHANGELOG

* Fix missing script result/return bug

* Fix github workflow for push

* Code improvement: app._parse_config (#391)

* Update app.py

* v0.8.10 (#392)

* Collect test coverage with scrutinizer instead of coveralls

* Restore coverage collecting with coveralls

* Update scrutinizer settings

* Add support for Python 3.8

* Fix static page and add unit test for it

* Delete obsolete test

* Dev cov (#394)

* Collect test coverage with scrutinizer instead of coveralls

* Restore coverage collecting with coveralls

* Update scrutinizer settings

* Add support for Python 3.8

* Fix static page and add unit test for it

* Delete obsolete test

* Restore scrutinizer configuration

* Linting as separate build step

* Restore scrutinizer configuration

* Update .scrutinizer.yml

* Update .scrutinizer.yml

* Restore scrutinizer configuration

* Update pull_request.yml

* Code style improvements

* Code style improvements

* Code style improvements

Co-authored-by: sbabayan <34922408+sbabayan@users.noreply.github.com>
Co-authored-by: Brennan Bugbee <Bugbeeb@gmail.com>
0golovatyi added a commit that referenced this pull request Jul 29, 2020
@0golovatyi @sbabayan
@phantomcosmonaut @nmannheimer
Code cleanup (#435)
ff09541 
* added anvoa to supported pre-deployed models in tabpy (#350)

* added anvoa to supported pre-deployed models in tabpy

* fixed pep8 issue

* fixed md

* Add Ctrl+C handler (#348)

* Add Ctrl+C handler

* Fix unit tests warnings for genson

* Add test to increase code coverage

* Add

* Change default from 10Mb to 100Mb for request size

* Increase code coverage

* Increase code coverage

* Convert buffer size to int

* Add Ctrl+C test

* Delete test added to the wrong folder

* Update CHANGELOG

* Update test_app.py

* Remove dead code

* Don't count coverage for multiline expressions

* Add test case for invalid protocol

* Add test case for _check_endpoint_name

* Remove dead code

* Fix vulnerabilities found by LGTM (#361)

* Fix vulnerabilities found by LGTM

* Fix test failures

* Dev improvements (#384)

* Fix flake8 warnings

* Merge from master

* Fix pycodestyle

* Fix more flake8 warnings

* Fix tests to pass again

* Create test_coveralls_codestyle.yml (#382)

* Use github actions

* Documentation improvements (#385)

* Delete .travis.yml

* Fix Ctrl+C failing on extra parameter in signal handler

* Remove outdated documentation for how to configure connection

* tabpy.py to use docopt

* Update tabpy-user with docopt

* Update CHANGELOG

* Fix code style

* Change regex, add remove method, and edit qeury_timeout (#375)

* Added Client.remove method to delete deployed model

* Fix bug for query_timeout types

* Update CHANGELOG

* Fix missing script result/return bug

* Fix github workflow for push

* Code improvement: app._parse_config (#391)

* Update app.py

* v0.8.10 (#392)

* Collect test coverage with scrutinizer instead of coveralls

* Restore coverage collecting with coveralls

* Update scrutinizer settings

* Add support for Python 3.8

* Fix static page and add unit test for it

* Delete obsolete test

* Dev cov (#394)

* Collect test coverage with scrutinizer instead of coveralls

* Restore coverage collecting with coveralls

* Update scrutinizer settings

* Add support for Python 3.8

* Fix static page and add unit test for it

* Delete obsolete test

* Restore scrutinizer configuration

* Linting as separate build step

* Restore scrutinizer configuration

* Update .scrutinizer.yml

* Update .scrutinizer.yml

* Restore scrutinizer configuration

* Update pull_request.yml

* Code style improvements

* Code style improvements

* Code style improvements

* Add coverall workflow

* Initial checkin, working tests.

* Made common base class for server info tests.

* pep8 checks.

* Added documentation for TABPY_AUTH_INFO

* Fix spacing.

* Refactor config parsing to allow custom parsers. (#412)

* Refactor config parsing to allow custom parsers.

* Fix pep8

* Update version and changelog.

* Changed default for tabpy_auth_info to a boolean.

* Secure info (#414)

* Update README.md

* Doc update (#402)

* Fixed broken link

* Linked to install doc.

* Dev fix spelling (#408)

* Add spelling fix workflow

* Refactor config parsing to allow custom parsers.

* Fix pep8

* Update version and changelog.

* Changed default for tabpy_auth_info to a boolean.

* Remove configuration for securing the info API and make it secure by default.

* Revert "Merge branch 'master' into secureInfo"

This reverts commit 3688561, reversing
changes made to a4acc65.

* Removed auth config from uni test.

Co-authored-by: nmannheimer <nathanmannheimer@gmail.com>
Co-authored-by: Oleksandr Golovatyi <olekg@outlook.com>

* Secure info (#417)

* Update README.md

* Doc update (#402)

* Fixed broken link

* Linked to install doc.

* Dev fix spelling (#408)

* Add spelling fix workflow

* Refactor config parsing to allow custom parsers.

* Fix pep8

* Update version and changelog.

* Changed default for tabpy_auth_info to a boolean.

* Remove configuration for securing the info API and make it secure by default.

* Revert "Merge branch 'master' into secureInfo"

This reverts commit 3688561, reversing
changes made to a4acc65.

* Removed auth config from uni test.

* Removed example for removed setting.

* Remove unused example config.

Co-authored-by: nmannheimer <nathanmannheimer@gmail.com>
Co-authored-by: Oleksandr Golovatyi <olekg@outlook.com>

* Clean up API documentation (#420)

* Update README.md

* Doc update (#402)

* Fixed broken link

* Linked to install doc.

* Dev fix spelling (#408)

* Add spelling fix workflow

* Update LICENSE

update to Tableau Software LLC

* v 1.1.0: Secure /info with auth (#415)

- Authorization is now required for the /info API method.
  This method did not check authentication previously. This change is
  backwards compatible with Tableau clients.

- Improved config parsing flexibility. Previously the
  TABPY_EVALUATE_TIMEOUT setting would be set to a default if
  tabpy couldn't parse the value. Now it will throw an exception
  at startup.

* Clean up API documentation

* Clean up API documentation

* Clean up API documentation

Co-authored-by: nmannheimer <nathanmannheimer@gmail.com>
Co-authored-by: lriggs <lriggs@tableau.com>
Co-authored-by: Olek Golovatyi <ogolovatyi@tableau.com>

* Code improvements (#431)

* Rename tabpy_server and tabpy_tools to server and tools (breaking change)

* fix flake8 warnings

* Clean up code to reduce number of conditions

* Remove pypi publishing instructions - those are Tableau specific

* Restore tabpy_tools and tabpy_server names

* Restore tabpy_tools and tabpy_server names

* Restore tabpy_tools and tabpy_server names

* Unit and integration tests passing

* Update .gitignore

* do not track settings.json for VSCode

* Fix server -> tabpy_server

* more cleaning for tabpy_server names

* make "python setup.py test" work

* add coverage module as required

* delete tests node for scrutinizer run

Co-authored-by: sbabayan <34922408+sbabayan@users.noreply.github.com>
Co-authored-by: ogolovatyi <ogolovatyi@OGOLOVATYI.tsi.lan>
Co-authored-by: Brennan Bugbee <Bugbeeb@gmail.com>
Co-authored-by: Logan Riggs <lriggs@tableau.com>
Co-authored-by: Olek Golovatyi <ogolovatyi@tableau.com>
Co-authored-by: nmannheimer <nathanmannheimer@gmail.com>
0golovatyi added a commit that referenced this pull request Aug 14, 2020
@0golovatyi @sbabayan
@phantomcosmonaut @nmannheimer @harold-xi
TabPy v2.0.0 (#441)
e8b0703 
* added anvoa to supported pre-deployed models in tabpy (#350)

* added anvoa to supported pre-deployed models in tabpy

* fixed pep8 issue

* fixed md

* Add Ctrl+C handler (#348)

* Add Ctrl+C handler

* Fix unit tests warnings for genson

* Add test to increase code coverage

* Add

* Change default from 10Mb to 100Mb for request size

* Increase code coverage

* Increase code coverage

* Convert buffer size to int

* Add Ctrl+C test

* Delete test added to the wrong folder

* Update CHANGELOG

* Update test_app.py

* Remove dead code

* Don't count coverage for multiline expressions

* Add test case for invalid protocol

* Add test case for _check_endpoint_name

* Remove dead code

* Fix vulnerabilities found by LGTM (#361)

* Fix vulnerabilities found by LGTM

* Fix test failures

* Dev improvements (#384)

* Fix flake8 warnings

* Merge from master

* Fix pycodestyle

* Fix more flake8 warnings

* Fix tests to pass again

* Create test_coveralls_codestyle.yml (#382)

* Use github actions

* Documentation improvements (#385)

* Delete .travis.yml

* Fix Ctrl+C failing on extra parameter in signal handler

* Remove outdated documentation for how to configure connection

* tabpy.py to use docopt

* Update tabpy-user with docopt

* Update CHANGELOG

* Fix code style

* Change regex, add remove method, and edit qeury_timeout (#375)

* Added Client.remove method to delete deployed model

* Fix bug for query_timeout types

* Update CHANGELOG

* Fix missing script result/return bug

* Fix github workflow for push

* Code improvement: app._parse_config (#391)

* Update app.py

* v0.8.10 (#392)

* Collect test coverage with scrutinizer instead of coveralls

* Restore coverage collecting with coveralls

* Update scrutinizer settings

* Add support for Python 3.8

* Fix static page and add unit test for it

* Delete obsolete test

* Dev cov (#394)

* Collect test coverage with scrutinizer instead of coveralls

* Restore coverage collecting with coveralls

* Update scrutinizer settings

* Add support for Python 3.8

* Fix static page and add unit test for it

* Delete obsolete test

* Restore scrutinizer configuration

* Linting as separate build step

* Restore scrutinizer configuration

* Update .scrutinizer.yml

* Update .scrutinizer.yml

* Restore scrutinizer configuration

* Update pull_request.yml

* Code style improvements

* Code style improvements

* Code style improvements

* Add coverall workflow

* Initial checkin, working tests.

* Made common base class for server info tests.

* pep8 checks.

* Added documentation for TABPY_AUTH_INFO

* Fix spacing.

* Refactor config parsing to allow custom parsers. (#412)

* Refactor config parsing to allow custom parsers.

* Fix pep8

* Update version and changelog.

* Changed default for tabpy_auth_info to a boolean.

* Secure info (#414)

* Update README.md

* Doc update (#402)

* Fixed broken link

* Linked to install doc.

* Dev fix spelling (#408)

* Add spelling fix workflow

* Refactor config parsing to allow custom parsers.

* Fix pep8

* Update version and changelog.

* Changed default for tabpy_auth_info to a boolean.

* Remove configuration for securing the info API and make it secure by default.

* Revert "Merge branch 'master' into secureInfo"

This reverts commit 3688561, reversing
changes made to a4acc65.

* Removed auth config from uni test.

Co-authored-by: nmannheimer <nathanmannheimer@gmail.com>
Co-authored-by: Oleksandr Golovatyi <olekg@outlook.com>

* Secure info (#417)

* Update README.md

* Doc update (#402)

* Fixed broken link

* Linked to install doc.

* Dev fix spelling (#408)

* Add spelling fix workflow

* Refactor config parsing to allow custom parsers.

* Fix pep8

* Update version and changelog.

* Changed default for tabpy_auth_info to a boolean.

* Remove configuration for securing the info API and make it secure by default.

* Revert "Merge branch 'master' into secureInfo"

This reverts commit 3688561, reversing
changes made to a4acc65.

* Removed auth config from uni test.

* Removed example for removed setting.

* Remove unused example config.

Co-authored-by: nmannheimer <nathanmannheimer@gmail.com>
Co-authored-by: Oleksandr Golovatyi <olekg@outlook.com>

* Clean up API documentation (#420)

* Update README.md

* Doc update (#402)

* Fixed broken link

* Linked to install doc.

* Dev fix spelling (#408)

* Add spelling fix workflow

* Update LICENSE

update to Tableau Software LLC

* v 1.1.0: Secure /info with auth (#415)

- Authorization is now required for the /info API method.
  This method did not check authentication previously. This change is
  backwards compatible with Tableau clients.

- Improved config parsing flexibility. Previously the
  TABPY_EVALUATE_TIMEOUT setting would be set to a default if
  tabpy couldn't parse the value. Now it will throw an exception
  at startup.

* Clean up API documentation

* Clean up API documentation

* Clean up API documentation

Co-authored-by: nmannheimer <nathanmannheimer@gmail.com>
Co-authored-by: lriggs <lriggs@tableau.com>
Co-authored-by: Olek Golovatyi <ogolovatyi@tableau.com>

* Code improvements (#431)

* Rename tabpy_server and tabpy_tools to server and tools (breaking change)

* fix flake8 warnings

* Clean up code to reduce number of conditions

* Remove pypi publishing instructions - those are Tableau specific

* Restore tabpy_tools and tabpy_server names

* Restore tabpy_tools and tabpy_server names

* Restore tabpy_tools and tabpy_server names

* Unit and integration tests passing

* Update .gitignore

* do not track settings.json for VSCode

* Fix server -> tabpy_server

* more cleaning for tabpy_server names

* make "python setup.py test" work

* add coverage module as required

* delete tests node for scrutinizer run

* Update postman collection

* remove print from error handling code (#439)

* remove print from error handling code

* remove & for linux cmd

Co-authored-by: Olek Golovatyi <ogolovatyi@tableau.com>

* Return HTTP 400 status when receiving a request with authentication credentials and authN is not configured (#440)

* added 400 bad request response to event when authorization is not set up but user sends username and password

* added unit tests to test what happens when there are credentials, but no authentication is required

* renamed not_authorized flag to authentication_error flag

* changed line formatting

* changed the way auth error is handled

* Version to 2.0.0

* Version to 2.0.0

* Fix codystyle warnings

* Restore scrutinizer settings

* Fix codestyle

Co-authored-by: sbabayan <34922408+sbabayan@users.noreply.github.com>
Co-authored-by: ogolovatyi <ogolovatyi@OGOLOVATYI.tsi.lan>
Co-authored-by: Brennan Bugbee <Bugbeeb@gmail.com>
Co-authored-by: Logan Riggs <lriggs@tableau.com>
Co-authored-by: Olek Golovatyi <ogolovatyi@tableau.com>
Co-authored-by: nmannheimer <nathanmannheimer@gmail.com>
Co-authored-by: harold-xi <69485232+harold-xi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johng42 johng42 johng42 approved these changes

@ChairmanMa0 ChairmanMa0 Awaiting requested review from ChairmanMa0

@jnegara jnegara Awaiting requested review from jnegara

@evaliula evaliula Awaiting requested review from evaliula

@nmannheimer nmannheimer Awaiting requested review from nmannheimer

@sbabayan sbabayan Awaiting requested review from sbabayan

@rxing-tableau rxing-tableau Awaiting requested review from rxing-tableau

Assignees

@0golovatyi 0golovatyi

Labels
documentation enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@0golovatyi @pep8speaks @johng42