Scotm 15990411

.github/workflows/check-coverage.yml

@@ -26,12 +26,11 @@ jobs:
 
     - name: Install dependencies
       run: |
+        python --version
         python -m pip install --upgrade pip
-        pip install -e .[install]
         pip install -e .[build]
         pip install -e .[test]
-        python setup.py build
-        python res/versioning.py
+        doit version
         python setup.py build
 
     #  https://github.com/marketplace/actions/pytest-coverage-comment
@@ -42,8 +41,9 @@ jobs:
       uses: MishaKav/pytest-coverage-comment@main
       with:
         pytest-coverage-path: ./pytest-coverage.txt
-        # broken? Error: The head commit for this pull_request event is not ahead of the base commit.
-        #  Please submit an issue on this action's GitHub repo
+        # TODO: check if this has been fixed
+        # Error: The head commit for this pull_request event is not ahead of the base commit.
+        # Please submit an issue on this action's GitHub repo
         # report-only-changed-files: true
 
     # TODO update badge on readme:

.github/workflows/generate-metadata.yml

@@ -25,6 +25,9 @@ jobs:
         doit version
         python setup.py build
 
+    - name: Generate dependencies list
+      run: python bin/license-checker.py
+
     - name: Type-check
       run: mypy src tests
 

.github/workflows/run-tests.yml

@@ -12,29 +12,27 @@ on:
 jobs:
   build:
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
 
     runs-on: ${{ matrix.os }}
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v2
 
     - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
 
     - name: Install dependencies
       run: |
-        python --version
         python -m pip install --upgrade pip
-        pip install -e .[build]
         pip install -e .[test]
-        doit version
-        python setup.py build
 
     - name: Test with pytest
-      run: pytest
+      run: |
+        pytest
+        pycodestyle tabcmd tests

.gitignore

@@ -8,6 +8,7 @@
 # python build files
 build/
 dist/
+venv/
 *.egg-info/
 *.egg
 eggs/
@@ -16,14 +17,12 @@ __pycache__/
 *.pytest_cache
 *.pyc
 *.pkl
-.coverage
 
 # code coverage outputs
 .coverage
 pytest.xml
 
 # content
-# todo probably want to add a workbook and ds in /res for getting started easily
 *.pdf
 *.png
 *.twbx
@@ -33,9 +32,9 @@ pytest.xml
 html
 *.html
 *.twbr
-**/credentials.py
-*.txt
 
-# doit
-.doit.*
+# local password files
+.token
+.credentials
+**/credentials.py
 

Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# gem "rails"
+gem 'github-pages'
+gem "webrick", "~> 1.7"

README.md

@@ -33,15 +33,24 @@ Or install the current work-in-progress version from Git\
 pip install git+https://github.com/tableau/tabcmd.git@development
 ```
 
-If you go this route, but want to switch back to the non-development version, you need to run the following command before installing the stable version:
+## Documentation
 
-```shell
-pip uninstall tabcmd
-```
+Read the [full user documentation for Tabcmd2](docs/index.md).
+
+## Get started
+
+This section describes how to install and configure tabcmd.
 
 ### Run tabcmd
 
-To run tabcmd from your local copy, from a console window in the same directory as the file tabcmd.py:
+To work with tabcmd, you need the following:
+
+* MacOS / Windows
+* Python 3.7+ installed
+
+### Installation
+
+To install tabcmd, follow these steps:
 
 1. Clone the repo
 2. Run `pip install .`
@@ -58,7 +67,7 @@ To run tabcmd from your local copy, from a console window in the same directory
 > coverage run -m pytest && coverage report -m
 
 - autoformat your code with black (https://pypi.org/project/black/)
-> black --line-length 120 src tests [--check]
+> black . [--check]
 
 - type check with mypy
 > mypy src tests
@@ -113,3 +122,8 @@ Copies of tabcmd that shipped with Tableau Server are referred to by the version
 At some point in the future, tabcmd will no longer be included with Tableau Server. 
 *We have no intention of breaking Server install flows.* 
 If you have specific suggestions or concerns on what that will look like, feel free to open an issue here or a thread on the Community Forums.
+
+
+See the LICENSE file for current open-source licensing and use information. See dev information at [contributing.md](./contributing.md)
+
+Before we can accept pull requests from contributors, we require a signed [Contributor License Agreement (CLA)](http://tableau.github.io/contributing.html).

_config.yml

@@ -0,0 +1,24 @@
+# Site settings
+title: tabcmd
+email: [email protected]
+description: Connect to your web data from Tableau.
+baseurl: "/tabcmd"
+# permalink: pretty
+defaults:
+  -
+    scope:
+      path: "" # Apply to all files
+    values:
+      layout: "default"
+
+# Build settings
+markdown: kramdown
+highlighter: rouge
+
+kramdown:
+    toc_levels: 2..2
+
+# Exclude
+exclude: ['node_modules', 'vendor']
+
+theme: jekyll-theme-minimal

_includes/analytics.html

@@ -0,0 +1,7 @@
+<!-- Google Tag Manager -->
+<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+})(window,document,'script','dataLayer','GTM-BVCN');</script>
+<!-- End Google Tag Manager -->

_includes/docs_menu.html

@@ -0,0 +1,19 @@
+<div class="well docs-menu col-xs-12 col-sm-4 col-md-3">
+    {% include search_form.html %}
+    <ul class="nav nav-list">
+
+        <li>
+            <a href="{{ site.baseurl }}/docs/tabcmd_whats_new.html">What's New?</a>
+        </li>
+        <li>
+            <a href="{{ site.baseurl }}/docs/index.html">Install tabcmd</a>
+        </li>
+        <li>
+            <a href="{{ site.baseurl }}/docs/tabcmd_cmd.html">tabcmd Commands</a>
+        </li>
+        <li>
+            <a href="{{ site.baseurl }}/docs/tabcmd_about.html">About Tabcmd</a>
+        </li>
+
+    </ul>
+</div>

_includes/footer.html

@@ -0,0 +1,9 @@
+<!-- Footer -->
+<footer>
+    <div class="row">
+            <hr class="footer-hr">
+            <p>This site is open source. Suggestions and pull requests are welcome on our <a href="https://github.com/tableau/tabcmd">GitHub page</a>.</p>
+            <p><a href="https://www.tableau.com/en-us/legal" class="aLegal">LEGAL</a> <a href="https://www.salesforce.com/company/privacy/" class="aLegal">PRIVACY</a> &copy; <script>document.write(new Date().getFullYear())</script> Salesforce, Inc.</p>
+            <sub>Documentation last generated on: {{ site.time }}</sub>
+    </div>
+</footer>

_includes/head.html

@@ -0,0 +1,18 @@
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
+  <meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
+
+  <link rel="shortcut icon" type="image/png" href="{{ site.baseurl }}/assets/logo.png">
+
+  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css">
+  <link rel="stylesheet" href="{{ site.baseurl }}/assets/css/main.css">
+  <link rel="stylesheet" href="{{ site.baseurl }}/assets/css/github-highlight.css">
+
+  <script src="{{ site.baseurl }}/assets/js/redirect-to-search.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script>
+
+{% if jekyll.environment == "production" %}{% include analytics.html %}{% endif %}

_includes/header.html

@@ -0,0 +1,29 @@
+<header class="site-header">
+  <div class="wrapper">
+    <nav class="navbar navbar-default navbar-fixed-top">
+      <div class="container">
+        <div class="navbar-header">
+          <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+            <span class="sr-only">Toggle navigation</span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+          </button>
+          <a class="navbar-brand navbar-brand-logo" href="{{ site.baseurl }}/#">Tableau tabcmd</a>
+        </div>
+        <div id="navbar" class="navbar-collapse collapse">
+          <ul class="nav navbar-nav">
+            <li><a href="{{ site.baseurl }}/docs/">Docs</a></li>
+            <li><a href="{{ site.baseurl }}/docs/tabcmd_cmd.html">tabcmd Reference</a></li>
+            <li><a href="https://community.tableau.com/s/topic/0TO4T000000QT6xWAG/tabcmd">Community Knowledge Base</a></li>
+            <li><a href="{{ site.baseurl }}/news/">What's New?</a></li>
+          </ul>
+          <ul class="nav navbar-nav navbar-right">
+            <li class="tableauIcon"><a target="_blank" href="http://tableau.com"><img src="{{ site.baseurl }}/assets/logo.png" alt="Tableau Developers" class="logo" /></a></li>
+            <li><a target="_blank" href="https://github.com/tableau/tabcmd"><span class="icon icon--github" title="tabcmd on GitHub" alt="tabcmd on GitHub">{% include icon-github.svg %}</span></a></li>
+          </ul>
+        </div><!--/.nav-collapse -->
+      </div>
+    </nav>
+  </div>
+</header>

_includes/search_form.html

@@ -0,0 +1,7 @@
+<div class="search-container form-group has-feedback">
+    <form id="docs-search">
+        <input type="search" id="search-input" class="custom-search form-control" placeholder="Search the docs..." search-url="{{ site.baseurl}}/docs/search.html">
+        <span class="glyphicon glyphicon-search form-control-feedback"></span>
+    </form>
+</div>
+

_layouts/api-ref.html

@@ -0,0 +1,20 @@
+---
+layout: api-ref
+---
+<!DOCTYPE html>
+<html>
+
+<head>
+    {% include head.html %}
+    <link rel="stylesheet" href="{{ site.baseurl }}/assets/css/api_ref.css">
+</head>
+
+<body>
+    <div class="container">
+        {% include header.html %}
+        {{ content }}
+        <script src="{{ site.baseurl }}/assets/js/api_ref.min.js"></script>
+    </div>
+</body>
+
+</html>

_layouts/community.html

@@ -0,0 +1,30 @@
+---
+layout: community
+---
+<!DOCTYPE html>
+<html>
+
+<head>
+    {% include head.html %}
+</head>
+
+<body>
+    <div class="container">
+        {% include header.html %}
+        <header id="community-jumbo" class="jumbotron hero-spacer">
+            <h2>{{ page.title }}</h2>
+            {{ content }}
+        </header>
+        <div class="row">
+            <div id="grid" data-columns>
+                <!-- dynamically loaded from community/community_connectors.json -->
+            </div>
+        </div>
+
+        <script src="{{ site.baseurl }}/assets/js/salvattore.min.js"></script>
+        <script src="{{ site.baseurl }}/assets/js/community_connectors.js"></script>
+        {% include footer.html %}
+    </div>
+</body>
+
+</html>

_layouts/default.html

@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+    {% include head.html %}
+</head>
+
+<body>
+    <div class="container">
+        {% include header.html %}
+        <ul class="blogul">
+            {% for post in site.posts %}
+            <div class="row">
+                <h1>{{ post.title }}</h1>
+                <hr>
+                <p><span class="glyphicon glyphicon-time"></span> Posted on {{ post.date | date: "%-d %B %Y" }}</p>
+                <hr>
+                <p class="lead">
+                    {{ post.abstract }}
+                </p>
+                {% if post.photoname %}
+                <img class="img-responsive" src="{{ site.baseurl }}/assets/{{ post.photoname}}" alt=""> {% endif %}
+                <hr>
+                <div class="blog-content">
+                    {{ post.content }}
+                </div>
+            </div>
+            {% endfor %}
+        </ul>
+        {% include footer.html %}
+    </div>
+</body>
+
+</html>