Merge remote-tracking branch 'origin' into feature-bounding-box

Author: joeyouss

.github/workflows/documentation.yml

@@ -0,0 +1,55 @@
+name: documentation
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  checks:
+    if: github.event_name != 'push'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - name: Test Build
+        run: |
+          cd docs
+          if [ -e yarn.lock ]; then
+            yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+            npm ci
+          else
+            npm i
+          fi
+          npm run build
+  gh-release:
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
+      - name: Release to GitHub Pages
+        env:
+          USE_SSH: true
+          GIT_USER: git
+        run: |
+          cd docs
+          git config --global user.email "[email protected]"
+          git config --global user.name "Saif Ul Islam"
+          if [ -e yarn.lock ]; then
+            yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+            npm ci
+          else
+            npm i
+          fi
+          npm run deploy

.github/workflows/pypi-publish.yml

@@ -0,0 +1,54 @@
+# This workflow will build the distributions with sdist, bdist_wheel, run tests, format, and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Mapillary Python SDK - Publishing to PyPi
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          pip install wheel build twine readme-renderer check-manifest
+
+      - name: Setup PyPi RC
+        run: |
+          touch ~/.pypirc
+          cat >> ~/.pypyirc <<EOL 
+          [distutils]
+          index-servers =
+            pypi
+            testpypi
+
+          [testpypi]
+          repository: https://test.pypi.org/legacy
+          username = ${{ secrets.PYPI_USERNAME }} 
+          password = ${{ secrets.PYPI_PASSWORD }} 
+
+          [pypi]
+          username = ${{ secrets.PYPI_USERNAME }} 
+          password = ${{ secrets.PYPI_PASSWORD }} 
+          EOL
+          
+      - name: Uploading To PyPi
+        run: |
+          python3 setup.py upload
+          
+      - name: Publish a Python distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: ${{ secrets.PYPI_USERNAME }} 
+          password: ${{ secrets.PYPI_PASSWORD }}

.github/workflows/pytest.yml

@@ -0,0 +1,36 @@
+# This workflow will install Python dependencies, run tests, format, and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Mapillary Python SDK - PyTest Workflow
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 black pytest requests mercantile vt2geojson mapillary
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Formatting with black
+      run: |
+        make format
+    - name: Lint with flake8
+      run: |
+        make lint
+    - name: Test with pytest
+      run: |
+        make test

.gitignore

@@ -26,6 +26,9 @@ share/python-wheels/
 *.egg
 MANIFEST
 
+# PyCharm
+.idea/
+
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
@@ -138,4 +141,7 @@ dmypy.json
 cython_debug/
 
 # Testing
-tests/helper/data/*.geojson
+tests/helper/data/*.geojson
+
+# Sphinx documentation generation
+sphinx-docs/

Makefile

@@ -1,7 +1,129 @@
 # Copyright (c) Facebook, Inc. and its affiliates. (http://www.facebook.com)
 
-style:
-	black src/mapillary && flake8 src/mapillary
+define PYTHON_SCRIPT
 
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../'))
+
+
+def skip(app, what, name, obj, would_skip, options):
+    '''Skip'''
+
+    extensions.append('sphinx_autodoc_typehints')
+
+    if name in ('__init__',):
+        return False
+    return would_skip
+
+
+    def setup(app):
+        '''Setup App'''
+
+        app.connect('autodoc-skip-member', skip)
+endef
+
+# SETUP
+
+# # Setup all
+setup: setup-prod setup-dev
+
+# # Install needed dependencies
+setup-prod:
+	python -m pip install --upgrade pip
+	pip install pipenv
+	pipenv install
+
+# # Install developer dependencies
+setup-dev:
+	python -m pip install --upgrade pip
+	pip install pipenv
+	pipenv install --dev
+
+# PACKAGE BUILD
+
+# # Build the package
+build:
+	# Builds the package distributions
+	python3 setup.py sdist bdist_wheel --universal
+
+local-install:
+	# Locally install mapillary - DO THIS ONLY AFTER RUNNING `make build`
+	pip3 install -e .
+
+# CODE QUALITY
+
+# # Styling related
+style: format lint
+
+# # # Formatting
+format:
+	@ black src/mapillary
+
+# # # Linting
+lint:
+	@ # stop the build if there are Python syntax errors or undefined names
+	@ flake8 src/mapillary --count --select=E9,F63,F7,F82 --show-source --statistics
+
+	@ # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+	@ flake8 src/mapillary --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+# DOCUMENTATION
+
+# # For generating the latest developer documentation from src/mapillary
+# # and serving them locally with Docusaurus
+docs-gen: docs-sphinx docs-py docs-start
+
+# # # Sphinx Documentation Generation
+docs-sphinx:
+	sphinx-apidoc -o sphinx-docs ./src/ sphinx-apidoc --full -A 'Mapillary'; cd sphinx-docs; echo "$$PYTHON_SCRIPT" >> conf.py; make markdown;
+
+# # # Python Script for moving markdown from sphinx -> docusaurus
+docs-py:
+	python3 scripts/documentation.py
+
+# # # Serve the newly generated documentation
+docs-start:
+	cd docs; npm run start;
+
+# # For pushing the docs to the gh-pages branch
+docs-push: docs-build docs-deploy
+
+# # # Building the static pages
+docs-build:
+	# Building the documentation
+	cd docs; npm run build;
+
+# # # Deploying the documentation to gh-pages
+docs-deploy:
+	# Deploying the documentation
+	# Deploying requires GIT_USER's password and write access to the repository
+	# If normal password authentication is used, deployment fails
+	# remote: Support for password authentication was removed on August 13, 2021.
+	# Please use a personal access token instead. See here for more information
+	# https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/
+	cd docs; GIT_USER=Rubix982 yarn deploy;
+
+# CLEANING
+
+# # Removing temporary created artifacts
+clean: sphinx-docs-clean docs-clean build-clean
+
+# # # Remove Sphinx Documentation
+sphinx-docs-clean:
+	rm -rf sphinx-docs/
+
+# # # Remove latest build of docs
+docs-clean:
+	rm -rf docs/build
+
+# # # Remove latest sr/mapillary build
+build-clean:
+	rm -rf build/ dist/
+
+# TESTING
+
+# # Execute pytest on tests/
 test:
 	@ pytest --log-cli-level=20

Pipfile

@@ -68,8 +68,11 @@ pycodestyle = "==2.7.0"
 pyflakes = "==2.3.1"
 regex = "==2021.4.4"
 toml = "==0.10.2"
-twine = "*"
-check-manifest = "*"
+twine = "==1.13.0"
+check-manifest = "==0.46"
+sphinx = "==4.1.2"
+sphinx-markdown-builder = "==0.5.4"
+sphinx-autodoc-typehints = "==1.12.0"
 
 [requires]
 python_version = "3.8"