slickml · amirhessam88 · May 30, 2022 · May 29, 2022 · May 29, 2022 · May 29, 2022
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,12 @@
+[run]
+branch = True
+parallel = True
+
+omit =
+    */__init__.py
+
+[report]
+show_missing = True
+
+[html]
+directory = htmlcov
diff --git a/.flake8 b/.flake8
@@ -1,15 +1,21 @@
 [flake8]
-max-line-length = 88
-ignore = C901, E501, E203, W503
-per-file-ignores =
-    setup.py: E302
+max-line-length = 100
+ignore = C901, E501, E203, W503, E402
 exclude =
-    .git
-    __pycache__
-    .venv
-    .pytest_cache
     .vscode
     .github
-	.ipynb_checkpoints
-    docs/conf.py
-	Makefile
+    .ipynb_checkpoints
+    .git,
+    __pycache__,
+    docs/conf.py,
+    old,
+    build,
+    dist,
+    .venv,
+    .venv/*,
+    **/.venv/,
+    .pytest_cache,
+    .tox,
+    .python-version,
+    conftest.py,
+    Makefile
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,57 @@
+name: Bug Report
+description: File a bug report
+title: "[BUG]: "
+labels: ["bug"]
+assignees:
+  - amirhessam88
+  - Tsmith5151
+body:
+  - type: markdown
+    attributes:
+      value: |
+        The SlickML🧞 team members appreciate your time to fill out this issue ...
+
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details [Optional]
+      description: How can we get in touch with you if we need more info?
+      placeholder: [email protected]
+    validations:
+      required: false
+
+  - type: dropdown
+    id: system-information
+    attributes:
+      label: What Operating System (OS) are you using?
+      multiple: true
+      options:
+        - Mac
+        - Linux
+        - Windows
+    validations:
+      required: true
+
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      placeholder: Please explain what heppened and what you expect to happen; the more details the better ...
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant Logs/Tracebacks
+      description: Please copy & paste what you see as log / error / traceback here. This will be automatically formatted into code via shell, so no need for backticks ...
+      render: shell
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/slickml/slick-ml/blob/master/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,6 @@
+# reference: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests
+blank_issues_enabled: true
+contact_links:
+  - name: SlickML Community Support
+    url: https://join.slack.com/t/slickml/shared_invite/zt-19taay0zn-V7R4jKNsO3n76HZM5mQfZA
+    about: Please ask and answer questions here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,48 @@
+name: Feature Request
+description: Request a new feature ...
+title: "[FEATURE]: "
+labels: ["enhancement"]
+assignees:
+  - amirhessam88
+  - Tsmith5151
+body:
+  - type: markdown
+    attributes:
+      value: |
+        The SlickML🧞 team members appreciate your time to fill out this feature request ...
+
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details [Optional]
+      description: How can we get in touch with you if we need more info?
+      placeholder: [email protected]
+    validations:
+      required: false
+
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Describe the feature you are interested in ...
+      description: A clear and concise description of what you would like to be implemented ...
+      placeholder: "The functionality that can be added to SlickML🧞 can be ..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: feature-problem
+    attributes:
+      label: Is your feature request related to a problem?
+      description: Please describe the problem in details and how do you solve your current problem with the current implementation of SlickML🧞 ...
+      placeholder: "I'm always frustrated when ..."
+    validations:
+      required: false
+
+  - type: textarea
+    id: feature-solution
+    attributes:
+      label: Any other comments?
+      description: Add any other context about the feature here ...
+      placeholder: "This is (also) related to issue #42."
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/other-issues.md b/.github/ISSUE_TEMPLATE/other-issues.md
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,56 @@
+name: build
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - "**.md"
+  pull_request:
+    paths-ignore:
+      - "**.md"
+jobs:
+  ci:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      fail-fast: false
+      matrix:
+        operating-system: [ubuntu-latest]
+        python-version: [3.9.7]
+    steps:
+      #----------------------------------------------
+      #       check-out repo and set-up python
+      #----------------------------------------------
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+      - name: Setup Python v${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      #----------------------------------------------
+      # -----  install & configure poetry  -----
+      #----------------------------------------------
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+      #----------------------------------------------
+      #  -----  install dependencies  -----
+      #----------------------------------------------
+      - name: Install Dependencies
+        run: poetry install -vv --no-root
+      #----------------------------------------------
+      # -----  install slickml  -----
+      #----------------------------------------------
+      - name: Install SlickML
+        run: poetry install
+      #----------------------------------------------
+      #  -----  run test suite  -----
+      #----------------------------------------------
+      - name: Run Test Suite
+        run: |
+          source .venv/bin/activate
+          poe check
+          poe test