tabpy 2.7.0__tar.gz → 2.7.1__tar.gz

tabpy-2.7.1/.github/ISSUE_TEMPLATE/tabpy-issue-report.md

@@ -0,0 +1,28 @@
+---
+name: TabPy Issue Report
+about: Create a report to help us improve
+title: ''
+labels: question
+assignees: ''
+
+---
+
+**Environment information:**
+ - OS: [Windows, Linux, Mac] and version
+ - Python version: [e.g. 3.6.5]
+ - TabPy release: [e.g. 0.4.1]
+
+**Describe the issue**
+A clear and concise description of what the issue is.
+
+**To Reproduce**
+Steps to reproduce the behavior: what commands to run, what files to modify, where to look for an error.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

tabpy-2.7.1/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,36 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+- [ ] Test A
+- [ ] Test B
+
+**Test Configuration**:
+* OS and version:
+* Python version:
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules

tabpy-2.7.1/.github/workflows/coverage.yml

@@ -0,0 +1,39 @@
+name: Code coverage
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    
+    strategy:
+      matrix:
+        python-version: [3.7]
+        os: [ubuntu-latest]
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install -r requirements_dev.txt
+
+    - name: Test with pytest
+      run: 
+        pytest tests --cov=tabpy --cov-config=setup.cfg
+      env:
+        COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+    
+    - name: Run coveralls
+      run: 
+        coveralls --service=github
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

tabpy-2.7.1/.github/workflows/docker-publish.yml

@@ -0,0 +1,47 @@
+name: Publish Docker Image for Release
+
+on:
+  release:
+    types: [published]
+    
+env:
+  IMAGE_NAME: tabpy
+
+jobs:
+  # Push image to GitHub Packages.
+  # See also https://docs.docker.com/docker-hub/builds/
+  push:
+    name: Push Docker image to GitHub Packages
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v2
+
+      - name: Build image
+        run: docker build . --file Dockerfile --tag $IMAGE_NAME
+
+      - name: Log into GitHub Container Registry
+        run: echo "${{ secrets.CR_PAT }}" | docker login https://ghcr.io -u ${{ github.actor }} --password-stdin
+
+      - name: Push image to GitHub Container Registry
+        run: |
+          IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME
+
+          # Change all uppercase to lowercase
+          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
+
+          # Strip git ref prefix from version
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+
+          # Strip "v" prefix from tag name
+          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+
+          # Use Docker `latest` tag convention
+          [ "$VERSION" == "master" ] && VERSION=latest
+
+          echo IMAGE_ID=$IMAGE_ID
+          echo VERSION=$VERSION
+
+          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
+          docker push $IMAGE_ID:$VERSION

tabpy-2.7.1/.github/workflows/lint.yml

@@ -0,0 +1,39 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    name: ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    
+    strategy:
+      matrix:
+        python-version: [3.7]
+        os: [ubuntu-latest]
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install -r requirements_dev.txt
+
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+       
+    - name: Markdownlint
+      uses: nosborn/github-action-markdown-cli@v1.1.1
+      with:
+        files: .

tabpy-2.7.1/.github/workflows/pull_request.yml

@@ -0,0 +1,31 @@
+name: Test Run on Pull Request
+
+on: [pull_request]
+
+jobs:
+  build:
+    name: ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install -r requirements_dev.txt
+
+    - name: Test with pytest
+      run: |
+        pytest tests

tabpy-2.7.1/.github/workflows/push.yml

@@ -0,0 +1,32 @@
+name: Test Run on Push
+
+on: [push]
+
+jobs:
+  build:
+    name: ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install -r requirements_dev.txt
+
+    - name: Test with pytest
+      run: |
+        pytest tests
+        

tabpy-2.7.1/.gitignore

@@ -0,0 +1,131 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.pyc
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+*_trial_temp*
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# NodeJS files and folders
+node_modules/
+package.json
+package-lock.json
+
+# OS generated
+.DS_Store
+
+# PyCharm
+.idea/
+
+# TabPy server artifacts
+tabpy/tabpy_server/state.ini
+tabpy/tabpy_server/query_objects
+tabpy/tabpy_server/staging
+
+# VS Code
+*.code-workspace
+.vscode/
+
+# etc
+setup.bat
+*~
+tabpy_log.log.1

tabpy-2.7.1/.pep8speaks.yml

@@ -0,0 +1,4 @@
+# File : .pep8speaks.yml
+
+flake8:
+        max-line-length: 98

tabpy-2.7.1/.scrutinizer.yml

@@ -0,0 +1,35 @@
+build:
+  environment:
+    python: 3.7.6
+  nodes:
+    coverage:
+      project_setup:
+        override:
+          - pip install -r requirements.txt
+          - pip install -r requirements_dev.txt
+      tests:
+        override:
+          - command: 'pytest tests --cov=tabpy --cov-config=setup.cfg'
+            coverage:
+              file: '.coverage'
+              config_file: 'setup.cfg'
+              format: 'py-cc'
+    analysis:
+      project_setup:
+        override: 
+          - pip install -r requirements.txt
+      tests:
+        override: [py-scrutinizer-run]
+  tests:
+    before:
+      - pip install -r requirements.txt
+    override: [pytest]
+checks:
+  python:
+    code_rating: true
+    duplicate_code: true
+filter:
+  excluded_paths:
+    - '*/tests/*'
+  dependency_paths:
+    - 'lib/*'

tabpy-2.7.1/CONTRIBUTING.md

@@ -0,0 +1,146 @@
+# TabPy Contributing Guide
+
+<!-- markdownlint-disable MD004 -->
+
+<!-- toc -->
+
+- [Environment Setup](#environment-setup)
+- [Prerequisites](#prerequisites)
+- [Cloning TabPy Repository](#cloning-tabpy-repository)
+- [Tests](#tests)
+  * [Unit Tests](#unit-tests)
+  * [Integration Tests](#integration-tests)
+- [Code Coverage](#code-coverage)
+- [TabPy in Python Virtual Environment](#tabpy-in-python-virtual-environment)
+- [Documentation Updates](#documentation-updates)
+- [TabPy with Swagger](#tabpy-with-swagger)
+- [Code styling](#code-styling)
+
+<!-- tocstop -->
+
+<!-- markdownlint-enable MD004 -->
+
+## Environment Setup
+
+The purpose of this guide is to enable developers of Tabpy to install the project
+and run it locally.
+
+## Prerequisites
+
+These are prerequisites for an environment required for a contributor to
+be able to work on TabPy changes:
+
+- Python 3.7, 3.8 or 3.9:
+  - To see which version of Python you have installed, run `python --version`.
+- git
+- Node.js for npm packages - install from <https://nodejs.org>.
+- NPM packages - install all with
+  `npm install markdown-toc markdownlint` command.
+
+## Cloning TabPy Repository
+
+1. Open your OS shell.
+2. Navigate to the folder in which you would like to save
+   your local TabPy repository.
+3. In the command prompt, enter the following commands:
+
+    ```sh
+    git clone https://github.com/tableau/TabPy.git
+    cd TabPy
+    ```
+
+4. Install all dependencies:
+
+   ```sh
+   python -m pip install --upgrade pip
+   pip install -r requirements.txt
+   pip install -r requirements_dev.txt
+   ```
+
+## Tests
+
+To run the whole test suite execute the following command:
+
+```sh
+pytest
+```
+
+### Unit Tests
+
+Unit tests suite can be executed with the following command:
+
+```sh
+pytest tests/unit
+```
+
+### Integration Tests
+
+Integration tests can be executed with the next command:
+
+```sh
+pytest tests/integration
+```
+
+## Code Coverage
+
+You can run unit tests to collect code coverage data. To do so run `pytest`
+either for server or tools test, or even combined:
+
+```sh
+pytest tests --cov=tabpy
+```
+
+## TabPy in Python Virtual Environment
+
+It is possible (and recommended) to run TabPy in a virtual environment. More
+details are on
+[TabPy in Python virtual environment](docs/tabpy-virtualenv.md) page.
+
+## Documentation Updates
+
+For any process, scripts or API changes documentation needs to be updated accordingly.
+Please use markdown validation tools like web-based [markdownlint](https://dlaa.me/markdownlint/)
+or npm [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli).
+
+TOC for markdown file is built with [markdown-toc](https://www.npmjs.com/package/markdown-toc):
+
+```sh
+markdown-toc -i docs/server-startup.md
+```
+
+To check markdown style for all the documentation use `markdownlint`:
+
+```sh
+markdownlint .
+```
+
+These checks will run as part of the build if you submit a pull request.
+
+## TabPy with Swagger
+
+You can invoke the TabPy Server API against a running TabPy instance with Swagger.
+
+- Make CORS related changes in TabPy configuration file: update `tabpy/tabpy-server/state.ini`
+  file in your local repository to have the next settings:
+
+```config
+[Service Info]
+Access-Control-Allow-Origin = *
+Access-Control-Allow-Headers = Origin, X-Requested-with, Content-Type
+Access-Control-Allow-Methods = GET, OPTIONS, POST
+```
+
+- Start a local instance of TabPy server following [TabPy Server Startup Guide](docs/server-startup.md).
+- Run a local copy of Swagger editor with steps provided at
+  [https://github.com/swagger-api/swagger-editor](https://github.com/swagger-api/swagger-editor).
+- Open `misc/TabPy.yml` in Swagger editor.
+- In case your TabPy server does not run on `localhost:9004` update
+  `host` value in `TabPy.yml` accordingly.
+
+## Code styling
+
+`flake8` is used to check Python code against our style conventions:
+
+```sh
+flake8 .
+```

tabpy-2.7.1/Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3
+
+WORKDIR /app
+
+# install the latest TabPy
+RUN python3 -m pip install --upgrade pip && python3 -m pip install --upgrade tabpy
+
+# start TabPy
+CMD ["sh", "-c", "tabpy"]
+
+# run startup script
+ADD start.sh /
+RUN chmod +x /start.sh
+CMD ["/start.sh"]

{tabpy-2.7.0/tabpy.egg-info → tabpy-2.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tabpy
-Version: 2.7.0
+Version: 2.7.1
 Summary: Web server Tableau uses to run Python scripts.
 Home-page: https://github.com/tableau/TabPy
 Download-URL: https://pypi.org/project/tabpy

tabpy-2.7.1/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

tabpy-2.7.1/app.json

@@ -0,0 +1,19 @@
+{
+    "name": "TabPy",
+    "description": "Analytics Extension implementation which expands Tableau's capabilities by allowing users to execute Python scripts and saved functions via Tableau's table calculations.",
+    "repository": "https://github.com/tableau/TabPy",
+    "logo": "https://raw.githubusercontent.com/tableau/TabPy/master/tabpy/tabpy_server/static/TabPy_logo.png",
+    "keywords": ["tableau", "python", "analytics-extension"],
+    "env":{
+        "USERNAME":{
+            "description": "Add your username",
+            "value": "gzanolli",
+            "required": true
+        },
+        "PASSWORD":{
+            "description": "Define your password",
+            "value": "P@ssw0rd",
+            "required": true
+        }
+    }
+}

tabpy-2.7.1/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master, dev ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '0 22 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1