Release: 1.3.0

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.1.0
+current_version = 2.0.0
 commit = True
 tag = True
 

.circleci/config.yml

@@ -1,27 +1,34 @@
 version: 2.1
 
 orbs:
-  python: circleci/python@0.2.1
+  python: circleci/python@1.0.0
   win: circleci/[email protected]
 
 workflows:
   version: 2
   build_test_deploy:
     jobs:
-      - build
+      - build:
+          filters:
+            branches:
+              ignore:
+                - gh-pages
 
       - test_integration:
           requires:
             - build
+          filters:
+            branches:
+              ignore:
+                - gh-pages
           matrix:
             parameters:
-              python-version: ["2.7.16", "2.7.18", "3.5.10", "3.6.5", "3.7.7", "3.8.6", "3.9.3", "latest"]
+              python-version: ["3.6.5", "3.7.7", "3.8.6", "3.9.3", "3.9.6", "3.9.9", "latest"]
 
       - hold:
           type: approval
           requires:
             - test_integration
-
           filters:
             branches:
               only:
@@ -33,36 +40,18 @@ workflows:
           requires:
             - hold
 
-  # upload_test:
-  #   triggers:
-  #     - schedule:
-  #         cron: "0,30 * * * *"
-  #         filters:
-  #           branches:
-  #             only:
-  #               - jh/use-xxhash-for-integration-test
-
-  #   jobs:
-  #     - build
-
-  #     - upload_test_job:
-  #         requires:
-  #           - build
-
 jobs:
   build:
     docker:
       - image: circleci/python:latest
     steps:
       - checkout:
           name: Checkout Git
-
       - run:
           name: Build Package
           command: |
             echo -e "Running sdist"
             python setup.py sdist
-
       - persist_to_workspace:
           root: /home/circleci/project/
           paths:
@@ -73,68 +62,39 @@ jobs:
     parameters:
       python-version:
         type: string
-
     docker:
       - image: circleci/python:<< parameters.python-version >>
-
     steps:
       - attach_workspace:
           at: /tmp/artifact
           name: Attach build artifact
-
       - run:
           name: Install package
           command: |
             pip install --user '/tmp/artifact'
-
-      - run:
-          name: Run integration test
-          command: |
-            python /tmp/artifact/tests/integration.py
-
-  upload_test_job:
-    description: Upload test
-    docker:
-      - image: circleci/python:latest
-
-    steps:
-      - attach_workspace:
-          at: /tmp/artifact
-          name: Attach build artifact
-
-      - run:
-          name: Install package
-          command: |
-            pip install '/tmp/artifact'
-
       - run:
           name: Run integration test
           command: |
             python /tmp/artifact/tests/integration.py
 
-
   deploy:
     docker:
       - image: circleci/python:latest
-
     steps:
       - attach_workspace:
           at: /tmp/artifact
           name: Attach build artifact
-
       - run:
           name: Install dependencies
           command: |
             pip install setuptools wheel twine
-
       - run:
           name: init .pypirc
           command: |
             cd /tmp/artifact
             echo -e "[pypi]" >> ~/.pypirc
             echo -e "username = $TWINE_USERNAME" >> ~/.pypirc
             echo -e "password = $TWINE_PASSWORD" >> ~/.pypirc
-
       - run:
           name: Upload to pypi
           command: |

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+## [DEVREL-XXXX]
+
+### Description:
+Please provide a short description of what this PR does
+
+### Depends on:
+- Does this PR depend on any other ones?
+
+### Includes changes from:
+- Does this PR includ changes from another PR?
+
+### I'd like feedback on:
+- What would you like feedback on?

.github/workflows/documentation.yml

@@ -0,0 +1,24 @@
+name: Documentation
+on:
+  push:
+    branches:
+      - develop
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@v2
+      - uses: actions/checkout@master
+        with:
+          fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+          ref: develop
+      - name: Build and Commit
+        uses: sphinx-notes/pages@v2
+        with:
+          documentation_path: './docs'
+          requirements_path: './docs/requirements.txt'
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages

.gitignore

@@ -108,3 +108,6 @@ venv.bak/
 Pipfile
 Pipfile.lock
 .vscode/launch.json
+.vscode/settings.json
+
+pyproject.toml

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.formatting.provider": "black"
+}

Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3.11-buster as builder
+
+RUN pip install poetry==1.8.3
+
+ENV POETRY_NO_INTERACTION=1 \
+    POETRY_VIRTUALENVS_IN_PROJECT=1 \
+    POETRY_VIRTUALENVS_CREATE=1 \
+    POETRY_CACHE_DIR=/tmp/poetry_cache
+
+WORKDIR /frameio
+
+COPY README.md README.md
+COPY pyproject.toml poetry.lock ./
+COPY frameioclient frameioclient
+
+RUN --mount=type=cache,target=$POETRY_CACHE_DIR poetry install --without dev
+
+ENTRYPOINT [ "poetry", "run", "fiocli" ]

Makefile

@@ -15,3 +15,24 @@ bump-patch:
 
 clean:
 	find . -name "*.pyc" -exec rm -f {} \;
+
+test:
+	cd tests && pipenv run python integration.py
+
+package:
+	pipenv run python3 setup.py sdist bdist_wheel
+
+build-docker:
+	docker build . -t benchmark
+
+run-benchmark:
+	docker run -it -e $1 benchmark
+
+format:
+	black frameioclient
+
+view-docs:
+	cd docs && pip install -r requirements.txt && make dev
+
+publish-docs:
+	cd docs && pip install -r requirements.txt && make jekyll && make publish

README.md

@@ -24,12 +24,58 @@ $ git clone https://github.com/frameio/python-frameio-client
 $ pip install .
 ```
 
-_Note: The Frame.io Python client may not work correctly in Python 3.8+_
+### Developing
+Install the package into your development environment and link to it by running the following:
+
+```sh
+pipenv install -e . -pre
+```
 
 ## Documentation
 
 [Frame.io API Documentation](https://developer.frame.io/docs)
 
+### Use CLI
+When you install this package, a cli tool called `fioctl` will also be installed to your environment.
+
+**To upload a file or folder**
+```sh
+fioctl \
+--token fio-u-YOUR_TOKEN_HERE  \
+--destination "YOUR TARGET FRAME.IO PROJECT OR FOLDER" \
+--target "YOUR LOCAL SYSTEM DIRECTORY" \
+--threads 8
+```
+
+**To download a file, project, or folder**
+```sh
+fioctl \
+--token fio-u-YOUR_TOKEN_HERE  \
+--destination "YOUR LOCAL SYSTEM DIRECTORY" \
+--target "YOUR TARGET FRAME.IO PROJECT OR FOLDER" \
+--threads 2
+```
+
+### Links
+
+**Sphinx Documentation**
+- https://pythonhosted.org/sphinxcontrib-restbuilder/
+- https://www.npmjs.com/package/rst-selector-parser
+- https://sphinx-themes.org/sample-sites/furo/_sources/index.rst.txt
+- https://developer.mantidproject.org/Standards/DocumentationGuideForDevs.html
+- https://sublime-and-sphinx-guide.readthedocs.io/en/latest/code_blocks.html
+- https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
+- https://stackoverflow.com/questions/64451966/python-sphinx-how-to-embed-code-into-a-docstring
+- https://pythonhosted.org/an_example_pypi_project/sphinx.html
+
+**Decorators**
+- https://docs.python.org/3.7/library/functools.html
+- https://realpython.com/primer-on-python-decorators/
+- https://www.sphinx-doc.org/en/master/usage/quickstart.html
+- https://www.geeksforgeeks.org/decorators-with-parameters-in-python/
+- https://stackoverflow.com/questions/43544954/why-does-sphinx-autodoc-output-a-decorators-docstring-when-there-are-two-decora
+
+
 ## Usage
 
 _Note: A valid token is required to make requests to Frame.io. Go to our [Developer Portal](https://developer.frame.io/) to get a token!_

docs/Makefile

@@ -0,0 +1,36 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = dist
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+publish:
+	python publish.py
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+jekyll:
+	sphinx-build -b jekyll . dist/markdown
+
+rst:
+	sphinx-build -b rst . dist/rst
+
+html:
+	sphinx-build -b html . dist/html
+
+dev:
+	sphinx-autobuild -b html . _build/html
+

docs/classes/assets.rst

@@ -0,0 +1,5 @@
+Assets
+=========================
+
+.. autoclass:: frameioclient.Asset
+    :members:

docs/classes/comments.rst

@@ -0,0 +1,5 @@
+Comments
+===================
+
+.. autoclass:: frameioclient.Comment
+    :members:

docs/classes/index.rst

@@ -0,0 +1,12 @@
+Classes
+=====================
+
+.. toctree::
+    users
+    assets
+    comments
+    logs
+    projects
+    teams
+    sharing
+    search

docs/classes/logs.rst

@@ -0,0 +1,5 @@
+Audit Logs
+===================
+
+.. autoclass:: frameioclient.AuditLogs
+    :members:

docs/classes/projects.rst

@@ -0,0 +1,5 @@
+Projects
+===================
+
+.. autoclass:: frameioclient.Project
+    :members:

docs/classes/search.rst

@@ -0,0 +1,5 @@
+Search
+===================
+
+.. autoclass:: frameioclient.Search
+    :members:

docs/classes/sharing.rst

@@ -0,0 +1,8 @@
+Sharing
+===================
+
+.. autoclass:: frameioclient.PresentationLink
+    :members:
+
+.. autoclass:: frameioclient.ReviewLink
+    :members: