Generated new targets, setup.py version changes

Signed-off-by: Saif Ul Islam <[email protected]>

Author: Rubix982

Makefile

@@ -15,26 +15,78 @@ def skip(app, what, name, obj,would_skip, options):
 	extensions.append('sphinx_autodoc_typehints')
 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
+	@ 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
+	@ # 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
 
-	# 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
 
-sphinx-docs:
+# # 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;
 
-sphinx-docs-clean:
-	rm -rf sphinx-docs/
+# # # 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;
 
-docs: docs-build docs-deploy
+# # 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
@@ -44,14 +96,25 @@ docs-deploy:
 	# https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/
 	cd docs; GIT_USER=Rubix982 yarn deploy;
 
-docs-build:
-	# Building the documentation
-	cd docs; npm run build;
+# 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
-
-clean: sphinx-docs-clean docs-clean

setup.py

@@ -10,7 +10,7 @@
     1. https://packaging.python.org/tutorials/packaging-projects/
     2. https://www.youtube.com/watch?v=GIF3LaRqgXo
 
-:copyight: (c) 2021 Facebook
+:copyright: (c) 2021 Facebook
 :license: MIT LICENSE
 """