Release v0.6.1

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: ""
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ""
+labels: ""
+assignees: ""
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/pytest.yml

@@ -0,0 +1,59 @@
+name: Install and Pytests
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+      - trunk-merge/**
+  pull_request:
+    branches:
+      - master
+      - develop
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    environment: testing
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-22.04]
+        python-version: [3.9]
+    steps:
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install python dependecies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements_test.txt
+
+      - name: Install CRIPT Python SDK
+        run: pip install .
+
+      - name: Run pytest
+        env:
+          IMAGE_VERSION: ${{ secrets.IMAGE_VERSION }}
+          ENVIRONMENT: ${{ secrets.ENVIRONMENT }}
+          DEBUG: ${{ secrets.DEBUG }}
+          SECRET_KEY: ${{ secrets.SECRET_KEY }}
+          GLOBUS_AUTH_CLIENT_ID: ${{ secrets.GLOBUS_AUTH_CLIENT_ID }}
+          GLOBUS_AUTH_SECRET: ${{ secrets.GLOBUS_AUTH_SECRET }}
+          GLOBUS_ACCESS_MANAGER_CLIENT_ID: ${{ secrets.GLOBUS_ACCESS_MANAGER_CLIENT_ID }}
+          GLOBUS_ACCESS_MANAGER_SECRET: ${{ secrets.GLOBUS_ACCESS_MANAGER_SECRET }}
+          GLOBUS_NATIVE_CLIENT_ID: ${{ secrets.GLOBUS_NATIVE_CLIENT_ID }}
+          GLOBUS_ENDPOINT_ID: ${{ secrets.GLOBUS_ENDPOINT_ID }}
+          STORAGE_PROVIDER: ${{ secrets.GLOBUS_ENDPOINT_ID }}
+          STORAGE_PATH: ${{ secrets.GLOBUS_ENDPOINT_ID }}
+        run: |
+          python -m pytest

.github/workflows/trunk.yml

@@ -0,0 +1,25 @@
+name: trunk
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+      - trunk-merge/**
+  pull_request:
+    branches:
+      - master
+      - develop
+  # Allows you (and trunk) to run this workflow
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  trunk:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Trunk Check
+        uses: trunk-io/trunk-action@v1

.gitignore

@@ -152,8 +152,12 @@ cython_debug/
 # Custom
 api_key.txt
 
+# jet brains IDE config directory
 .idea/
 
+# vscode config directory
+.vscode/
+
 # PyCharm
 #  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore

.trunk/.gitignore

@@ -0,0 +1,7 @@
+*out
+*logs
+*actions
+*notifications
+plugins
+user_trunk.yaml
+user.yaml

.trunk/configs/.flake8

@@ -0,0 +1,3 @@
+# Autoformatter friendly flake8 config (all formatting rules disabled)
+[flake8]
+extend-ignore = D1, D2, E1, E2, E3, E501, W1, W2, W3, W5

.trunk/configs/.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+profile=black

.trunk/configs/.markdownlint.yaml

@@ -0,0 +1,10 @@
+# Autoformatter friendly markdownlint config (all formatting rules disabled)
+default: true
+blank_lines: false
+bullet: false
+html: false
+indentation: false
+line_length: false
+spaces: false
+url: false
+whitespace: false

.trunk/trunk.yaml

@@ -0,0 +1,32 @@
+version: 0.1
+cli:
+  version: 1.2.1
+plugins:
+  sources:
+    - id: trunk
+      ref: v0.0.8
+      uri: https://github.com/trunk-io/plugins
+lint:
+  enabled:
+    - [email protected]
+    - git-diff-check
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+runtimes:
+  enabled:
+    - [email protected]
+    - [email protected]
+    - [email protected]
+actions:
+  disabled:
+  enabled:
+    - trunk-announce
+    - trunk-upgrade-available
+    - trunk-check-pre-push
+    - trunk-fmt-pre-commit

README.md

@@ -1,21 +1,46 @@
 # CRIPT Python SDK
 
-**CRIPT** (the _Community Resource for Innovation in Polymer Technology_) is a web-based platform for capturing and sharing polymer data. 
+![CRIPT Logo](/CRIPT_full_logo_colored_transparent.png)
 
-Programmatic access to the platform is enabled through the CRIPT Python SDK.
+[![License](https://img.shields.io/github/license/C-Accel-CRIPT/cript?style=flat-square)](https://github.com/C-Accel-CRIPT/cript/blob/master/LICENSE.txt)
+[![Python](https://img.shields.io/badge/Language-Python%203.9+-blue?style=flat-square&logo=python)](https://www.python.org/)
+[![Code style is black](https://img.shields.io/badge/Code%20Style-black-000000.svg?style=flat-square&logo=python)](https://github.com/psf/black)
+[![Link to CRIPT website](https://img.shields.io/badge/platform-criptapp.org-blueviolet?style=flat-square)](https://criptapp.org/)
+[![CRIPT Blog Link](https://img.shields.io/badge/Blog-blog.criptapp.org-blueviolet?style=flat-square)](https://blog.criptapp.org)
+[![Material MkDocs](https://img.shields.io/badge/Docs-mkdocs--material-blueviolet?style=flat-square&logo=markdown)](https://squidfunk.github.io/mkdocs-material/)
 
-## Quickstart
+## What is it?
 
-### Prerequisites
-- Python 3.9+
-- Internet access
+The CRIPT Python SDK allows programmatic access to the [CRIPT platform](https://criptapp.org). It can help automate uploading your data to CRIPT, and aims to allow for manipulation of your CRIPT data through the python language. This is a perfect tool to use when you have some experience with python and have large amount of data to upload to [CRIPT](https://criptapp.org).
+
+---
+
+## Installation
+
+CRIPT Python SDK requires Python 3.9+
+
+The latest released of CRIPT Python SDK is available on [Python Package Index (PyPI)](https://pypi.org/project/cript/)
 
-### Install with pip
 ```bash
 pip install cript
 ```
 
-## Links
-- SDK documentation: https://c-accel-cript.github.io/cript/
-- Platform: https://criptapp.org
-- Blog: https://blog.criptapp.org
+---
+
+## Documentation
+
+To learn more about the CRIPT Python SDK please check the [CRIPT-SDK documentation](https://c-accel-cript.github.io/cript/)
+
+---
+
+## Release Notes
+
+For updates and release notes please visit the [CRIPT blog](https://blog.criptapp.org)
+
+### Software development
+
+You are welcome to contribute code via PR to this repository.
+For the developmet, we are using [trunk.io](https://trunk.io) to achieve a consistent coding style.
+You can run `./trunk fmt` to auto-format your contributions and `./trunk check` to verify your contribution complies with our standard via trunk.
+We will run the same test automatically before we are able to merge the code.
+Please, let us know if there are any issues.