Feature/initial pr

.github/actions/poetry/action.yml

@@ -0,0 +1,25 @@
+name: 'Poetry'
+description: 'Install python poetry'
+
+inputs:
+  version:
+    description: "Version of poetry to install"
+    required: false
+    default: "1.5.1"
+
+outputs:
+  version:
+    description: "Installed version"
+    value: ${{ steps.poetry-version.outputs.version }}
+
+runs:
+  using: "composite"
+  steps:
+    - run: |
+        curl -sSL https://install.python-poetry.org | python - --yes --version ${{ inputs.version }}
+        echo "$HOME/.local/bin" >> $GITHUB_PATH
+      shell: bash
+
+    - id: poetry-version
+      run: echo "version=$(poetry --version)" >> $GITHUB_OUTPUT
+      shell: bash

.github/dependabot.yml

@@ -0,0 +1,15 @@
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    versioning-strategy: increase-if-necessary
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/pull_request_template.md

@@ -0,0 +1,22 @@
+## Description
+
+<!--- Describe your changes -->
+
+## Motivation and Context
+
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Checklist
+
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
+- [ ] I have updated the documentation accordingly.
+- [ ] All new and existing tests passed.

.github/release.yml

@@ -0,0 +1,23 @@
+changelog:
+  exclude:
+    labels:
+      - ignore for notes
+  categories:
+    - title: Incompatible Changes
+      labels:
+        - incompatible changes
+    - title: Features
+      labels:
+        - feature
+    - title: Bugfixes
+      labels:
+        - bug
+    - title: Other Changes
+      labels:
+        - "*"
+      exclude:
+        labels:
+          - dependencies
+    - title: Dependency Updates
+      labels:
+        - dependencies

.github/workflows/lint.yml

@@ -0,0 +1,38 @@
+name: Lint
+on: [push, pull_request]
+env:
+  PYTHON_VERSION: 3.9
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install Poetry
+        uses: ./.github/actions/poetry
+
+      - name: Install Pre-commit
+        run: |
+          poetry install --only ci
+        env:
+          POETRY_VIRTUALENVS_CREATE: false
+
+      - name: Restore pre-commit cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ runner.os }}-py${{ env.PYTHON_VERSION }}-${{ hashFiles('.pre-commit-config.yaml') }}
+          restore-keys: pre-commit-${{ runner.os }}-py${{ env.PYTHON_VERSION }}
+
+      - name: Lint
+        run: pre-commit run --all-files --show-diff-on-failure

.github/workflows/mypy.yml

@@ -0,0 +1,32 @@
+name: Mypy (Type check)
+on: [push, pull_request]
+env:
+  PYTHON_VERSION: 3.9
+
+jobs:
+  mypy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python 🐍
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install Poetry 🎸
+        uses: ./.github/actions/poetry
+
+      - name: Install OS Packages 🧰
+        run: |
+          sudo apt-get update
+          sudo apt-get install --yes libxmlsec1-dev libxml2-dev
+
+      - name: Install Python Packages 📦
+        run: poetry install --without ci
+
+      - name: Run MyPy 🪄
+        run: poetry run mypy

.github/workflows/test-build.yml

@@ -0,0 +1,55 @@
+name: Test & Build
+on: [push, pull_request]
+
+concurrency:
+  group: test-build-${{ github.ref_name }}-${{ github.event_name }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: ${{ matrix.module }} Tests (Py ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+        module: [Core]
+
+    # We want to run on external PRs, but not on our own internal PRs as they'll be run
+    # by the push to the branch. This prevents duplicated runs on internal PRs.
+    # Some discussion of this here:
+    # https://github.community/t/duplicate-checks-on-push-and-pull-request-simultaneous-event/18012
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+
+    steps:
+      - uses: actions/checkout@v3
+
+      # See comment here: https://github.com/actions/runner-images/issues/1187#issuecomment-686735760
+      - name: Disable network offload
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Apt Packages
+        run: |
+          sudo apt-get update
+
+      - name: Install Poetry
+        uses: ./.github/actions/poetry
+
+      - name: Install Tox
+        run: |
+          poetry install --only ci
+        env:
+          POETRY_VIRTUALENVS_CREATE: false
+
+      - name: Run Tests
+        run: tox
+        env:
+          MODULE: ${{ matrix.module }}

.gitignore

@@ -0,0 +1,3 @@
+__pycache__
+.idea
+.tox

.pre-commit-config.yaml

@@ -0,0 +1,71 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-json
+      - id: check-ast
+      - id: check-toml
+      - id: check-shebang-scripts-are-executable
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-added-large-files
+      - id: mixed-line-ending
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.3.2
+    hooks:
+      - id: pyupgrade
+        args:
+          - --py38-plus
+          - --keep-runtime-typing
+
+  - repo: https://github.com/myint/autoflake
+    rev: v2.1.1
+    hooks:
+      - id: autoflake
+        args:
+          - --in-place
+          - --remove-all-unused-imports
+          - --ignore-init-module-imports
+
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+        name: Run black
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: Run isort
+
+  - repo: https://github.com/sirosen/check-jsonschema
+    rev: 0.22.0
+    hooks:
+      - id: check-github-workflows
+      - id: check-github-actions
+
+  - repo: https://github.com/pappasam/toml-sort
+    rev: v0.23.0
+    hooks:
+      - id: toml-sort
+        args: []
+        files: pyproject.toml
+
+  - repo: https://github.com/jackdewinter/pymarkdown
+    rev: v0.9.9
+    hooks:
+      - id: pymarkdown
+        args:
+          - --config
+          - .pymarkdown.config.json
+          - scan
+
+# Exclude test files, since they may be intentionally malformed
+exclude: ^tests/(core)/files/

.pymarkdown.config.json

@@ -0,0 +1,21 @@
+{
+  "plugins" : {
+    "line-length" : {
+      "line_length" : 120,
+      "heading_line_length": 120,
+      "code_block_line_length": 120
+    },
+    "no-duplicate-heading" : {
+      "allow_different_nesting": true
+    },
+    "ul-indent" : {
+      "indent" : 4
+    },
+    "blanks-around-fences" : {
+      "list_items": false
+    },
+    "first-line-heading" : {
+      "enabled": false
+    }
+  }
+}

README.md

@@ -1,2 +1,30 @@
-# palace-quicksight
-AWS QuickSight Resources for Palace
+# Palace Quicksight Tools
+
+A suite of command line operations for exporting and importing quicksight dashboards from and to AWS accounts.
+Exported resources can be found [here](https://github.com/ThePalaceProject/palace-quicksight-resources).
+
+## Prerequisites
+
+Install Poetry: [Installation instructions here](https://python-poetry.org/docs/).
+
+## Installation
+
+```shell
+poetry install
+poetry run ./bin/palace-quicksight --help
+```
+
+## Usage
+
+```shell
+./bin/palace-quicksight --help
+Usage: palace-quicksight [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  export-analysis    Creates a template from the analysis and exports at...
+  import-template    Import template and datasource files from json
+  publish-dashboard  Create/Update a dashboard from a template
+```

bin/palace-quicksight

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+"""The entry point for Palace Quicksight Tools"""
+import os
+import sys
+
+from core.cli import cli
+
+bin_dir = os.path.split(__file__)[0]
+package_dir = os.path.join(bin_dir, "..")
+sys.path.append(os.path.abspath(package_dir))
+
+cli()