Introduce workflow for element-zstack

.cspell.json

@@ -0,0 +1,62 @@
+// cSpell Settings
+//https://github.com/streetsidesoftware/vscode-spell-checker
+{
+    "version": "0.2", // Version of the setting file.  Always 0.2
+    "language": "en", // language - current active spelling language
+    "enabledLanguageIds": [
+        "markdown",
+        "yaml",
+        "python"
+    ],
+    // flagWords - list of words to be always considered incorrect
+    // This is useful for offensive words and common spelling errors.
+    // For example "hte" should be "the"
+    "flagWords": [],
+    "allowCompoundWords": true,
+    "ignorePaths": [
+        "./element_*.egg-info/*",
+        "./images/*"
+    ],
+    "words": [
+        "asarray",
+        "astype",
+        "Berens",
+        "bossdb",
+        "CICD",
+        "connectome",
+        "Connectomics",
+        "DBURLs",
+        "djarchive",
+        "DJARCHIVE",
+        "Ecker",
+        "elif",
+        "Ephys",
+        "genotyping",
+        "Hoenselaar",
+        "IACUC",
+        "inlinehilite",
+        "Kasthuri",
+        "linenums",
+        "mkdocs",
+        "mkdocstrings",
+        "numpy",
+        "pymdownx",
+        "pyproject",
+        "pytest",
+        "Reimer",
+        "Roboto",
+        "RRID",
+        "Rxiv",
+        "Sasaki",
+        "segmentations",
+        "Shen",
+        "Siapas",
+        "Sinz",
+        "Sitonic",
+        "Tolias",
+        "voxel",
+        "witvliet",
+        "Yatsenko",
+        "Zuckerman"
+    ]
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+## Bug Report
+
+### Description
+
+A clear and concise description of what is the overall operation that is intended to be
+performed that resulted in an error.
+
+### Reproducibility
+Include:
+- OS (WIN | MACOS | Linux)
+- DataJoint Element Version
+- MySQL Version
+- MySQL Deployment Strategy (local-native | local-docker | remote)
+- Minimum number of steps to reliably reproduce the issue
+- Complete error stack as a result of evaluating the above steps
+
+### Expected Behavior
+A clear and concise description of what you expected to happen.
+
+### Screenshots
+If applicable, add screenshots to help explain your problem.
+
+### Additional Research and Context
+Add any additional research or context that was conducted in creating this report.
+
+For example:
+- Related GitHub issues and PR's either within this repository or in other relevant
+  repositories.
+- Specific links to specific lines or a focus within source code.
+- Relevant summary of Maintainers development meetings, milestones, projects, etc.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: DataJoint Contribution Guideline
+    url: https://datajoint.com/docs/community/contribute/
+    about: Please make sure to review the DataJoint Contribution Guidelines

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,57 @@
+---
+name: Feature request
+about: Suggest an idea for a new feature
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+## Feature Request
+
+### Problem
+
+A clear and concise description how this idea has manifested and the context. Elaborate
+on the need for this feature and/or what could be improved. Ex. I'm always frustrated
+when [...]
+
+### Requirements
+
+A clear and concise description of the requirements to satisfy the new feature. Detail
+what you expect from a successful implementation of the feature. Ex. When using this
+feature, it should [...]
+
+### Justification
+
+Provide the key benefits in making this a supported feature. Ex. Adding support for this
+feature would ensure [...]
+
+### Alternative Considerations
+
+Do you currently have a work-around for this? Provide any alternative solutions or
+features you've considered.
+
+### Related Errors
+Add any errors as a direct result of not exposing this feature.
+
+Please include steps to reproduce provided errors as follows:
+- OS (WIN | MACOS | Linux)
+- DataJoint Element Version
+- MySQL Version
+- MySQL Deployment Strategy (local-native | local-docker | remote)
+- Minimum number of steps to reliably reproduce the issue
+- Complete error stack as a result of evaluating the above steps
+
+### Screenshots
+If applicable, add screenshots to help explain your feature.
+
+### Additional Research and Context
+Add any additional research or context that was conducted in creating this feature request.
+
+For example:
+- Related GitHub issues and PR's either within this repository or in other relevant
+  repositories.
+- Specific links to specific lines or a focus within source code.
+- Relevant summary of Maintainers development meetings, milestones, projects, etc.
+- Any additional supplemental web references or links that would further justify this
+  feature request.

.github/workflows/u24_workflow_before_release.yaml

@@ -0,0 +1,18 @@
+name: u24_workflow_before_release_0.0.1
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - '**'
+  workflow_dispatch:
+jobs:
+  call_context_check:
+    uses: dj-sciops/djsciops-cicd/.github/workflows/context_check.yaml@main
+  call_u24_workflow_build_debian:
+    uses: dj-sciops/djsciops-cicd/.github/workflows/u24_workflow_build.yaml@main
+    with:
+      jhub_ver: 1.4.2
+      py_ver: 3.9
+      dist: debian

.github/workflows/u24_workflow_release_call.yaml

@@ -0,0 +1,20 @@
+name: u24_workflow_release_call_0.0.1
+on:
+  workflow_run:
+    workflows: ["u24_workflow_tag_to_release_0.0.1"]
+    types:
+      - completed
+jobs:
+  call_context_check:
+    uses: dj-sciops/djsciops-cicd/.github/workflows/context_check.yaml@main
+  call_u24_workflow_release_debian:
+    if: >-
+      github.event.workflow_run.conclusion == 'success' && github.repository_owner == 'datajoint'
+    uses: dj-sciops/djsciops-cicd/.github/workflows/u24_workflow_release.yaml@main
+    with:
+      jhub_ver: 1.4.2
+      py_ver: 3.9
+      dist: debian
+    secrets:
+      REGISTRY_USERNAME: ${{secrets.DOCKER_USERNAME}}
+      REGISTRY_PASSWORD: ${{secrets.DOCKER_PASSWORD}}

.github/workflows/u24_workflow_tag_to_release.yaml

@@ -0,0 +1,15 @@
+name: u24_workflow_tag_to_release_0.0.1
+on:
+  push:
+    tags:
+      - '*.*.*'
+      - 'test*.*.*'
+jobs:
+  call_context_check:
+    uses: dj-sciops/djsciops-cicd/.github/workflows/context_check.yaml@main
+  call_u24_workflow_build_debian:
+    uses: dj-sciops/djsciops-cicd/.github/workflows/u24_workflow_build.yaml@main
+    with:
+      jhub_ver: 1.4.2
+      py_ver: 3.9
+      dist: debian

.gitignore

@@ -0,0 +1,80 @@
+# User files and data directories
+example_data/
+test.ipynb
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution, packaging, PyInstaller
+.Python
+env/
+build/
+*egg*/
+*dist/
+downloads/
+lib*/
+parts/
+var/
+wheels/
+.installed.cfg
+*.egg
+*.manifest
+*.spec
+pip-*.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+*.cov*
+.cache
+nosetests.xml
+coverage.xml
+.hypothesis/
+.pytest_cache/
+
+# C extension, Translations
+# editors: vscode, emacs, Mac
+*.so
+*.mo
+*.pot
+.vscode
+**/*~
+**/#*#
+**/.#*
+.DS_Store
+
+# Django, Flask, Scrapy, Sphinx, mkdocs
+# PyBuilder, Jupyter, SageMath, celery beat
+*.log
+local_settings.py
+instance/
+.webassets-cache
+.scrapy
+scratchpaper.*
+docs/_build/
+/site
+target/
+.*checkpoints
+celerybeat-schedule
+*.sage.py
+
+# dotenv, virtualenv, pyenv, mypy
+.*env
+venv/
+ENV/
+.python-version
+.mypy_cache/
+
+# Spyder/Rope project settings
+.spy*project
+.ropeproject
+
+# datajoint, notes, nwb export
+dj_local_c*.json
+temp*
+*nwb
+
+# vscode
+*.code-workspace

.pre-commit-config.yaml

@@ -0,0 +1,58 @@
+default_stages: [commit, push]
+exclude: (^.github/|^docs/|^images/|^notebooks/py_scripts/)
+
+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-added-large-files # prevent giant files from being committed
+      - id: requirements-txt-fixer
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+        description: Forces to replace line ending by the UNIX 'lf' character.
+
+  # black
+  - repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+      - id: black
+      - id: black-jupyter
+        args:
+          - --line-length=88
+
+  # isort
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+        description: Sorts imports in an alphabetical order
+
+  # flake8
+  - repo: https://github.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        args: # arguments to configure flake8
+          # making isort line length compatible with black
+          - "--max-line-length=88"
+          - "--max-complexity=18"
+          - "--select=B,C,E,F,W,T4,B9"
+
+          # these are errors that will be ignored by flake8
+          # https://www.flake8rules.com/rules/{code}.html
+          - "--ignore=E203,E501,W503,W605,E402"
+          # E203 - Colons should not have any space before them.
+          #        Needed for list indexing
+          # E501 - Line lengths are recommended to be no greater than 79 characters.
+          #        Needed as we conform to 88
+          # W503 - Line breaks should occur after the binary operator.
+          #        Needed because not compatible with black
+          # W605 - a backslash-character pair that is not a valid escape sequence now
+          #        generates a DeprecationWarning. This will eventually become a SyntaxError.
+          #        Needed because we use \d as an escape sequence
+          # E402 - Place module level import at the top.
+          #        Needed to prevent circular import error

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
+[Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
+
+## [0.1.0] - Unreleased
+
++ Add - Workflow pipeline, pytests, CICD
+
+[0.1.0]: https://github.com/datajoint/workflow-zstack/releases/tag/0.1.0