Example custom bounds

.editorconfig

@@ -0,0 +1,46 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{js,py}]
+charset = utf-8
+
+# 4 space indentation
+[*.py]
+max_line_length = 120
+indent_style = space
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false
+
+[mkdocs.yml]
+indent_size = 2
+
+# Tab indentation (no size specified)
+[Makefile]
+max_line_length = 150
+indent_style = tab
+trim_trailing_whitespace = false
+
+# Indentation override for all JS under lib directory
+[lib/**.js]
+indent_style = space
+indent_size = 2
+
+# Matches the exact files either package.json or .travis.yml
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2

.github/workflows/main.yml

@@ -13,9 +13,9 @@ jobs:
     steps:
     - name: Git config
       run: git config --global core.autocrlf input
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python v${{matrix.python-version}} - ${{runner.os}}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{matrix.python-version}}
         cache: pip
@@ -42,23 +42,30 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: [3.7]
+        python-version: [3.11]
     needs: "lint_and_test"
+    if: github.ref == 'refs/heads/main'
     steps:
+    - name: Install cairo
+      run: sudo apt-get install libcairo2-dev
     - name: Git config
       run: git config --global core.autocrlf input
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python v${{matrix.python-version}} - ${{runner.os}}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{matrix.python-version}}
         cache: pip
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip setuptools wheel
         pip install -r requirements.txt
+        pip install -r requirements-cairo.txt
         pip install -r requirements-examples.txt
     - name: Build examples
+      env:
+          API_KEY_JAWG: ${{ secrets.API_KEY_JAWG }}
+          API_KEY_STADIA: ${{ secrets.API_KEY_STADIA }}
       run: |
         cd examples
         mkdir build
@@ -74,7 +81,50 @@ jobs:
         (ls  *cairo*.png && mv  *cairo*.png build/.) || echo "no cairo png files found!"
         cd -
     - name: Archive examples
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v4
       with:
         name: build_examples
         path: examples/build
+  deploy:
+    runs-on: ${{matrix.os}}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.11]
+    needs: "build"
+    if: github.ref == 'refs/heads/main'
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Setup git and push to remote
+      run: |
+        export GIT_USER=${{ github.actor }}
+        git config --global core.autocrlf input
+    - name: Git clone
+      run: git clone https://github.com/lowtower/py-staticmaps --branch assets assets
+    - name: Download artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: build_examples
+    - name: Move pictures and commit
+      run: |
+        mv *.png assets/.
+        mv *.svg assets/.
+        cd assets
+        git config --local user.email "github-actions[bot]@users.noreply.github.com"
+        git config --local user.name "github-actions[bot]"
+        git fetch
+        git pull
+        git add *.png
+        git add *.svg
+        git commit -m "Automatic update of example image files `date +\"%d-%m-%Y %T\"`"
+        git status
+        pwd
+        ls -lrt
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        directory: assets
+        branch: assets

Makefile

@@ -1,37 +1,87 @@
+PROJECT=staticmaps
+SRC_CORE=staticmaps
+SRC_TEST=tests
+SRC_EXAMPLES=examples
+SRC_COMPLETE=$(SRC_CORE) $(SRC_TEST) $(SRC_EXAMPLES) docs/gen_ref_pages.py
+PYTHON=python3
+
+help: ## Print help for each target
+	$(info Makefile low-level Python API.)
+	$(info =============================)
+	$(info )
+	$(info Available commands:)
+	$(info )
+	@grep '^[[:alnum:]_-]*:.* ##' $(MAKEFILE_LIST) \
+		| sort | awk 'BEGIN {FS=":.* ## "}; {printf "%-25s %s\n", $$1, $$2};'
+
+clean: ## Cleanup
+	@rm -rf ./.env
+	@rm -f  ./*.pyc
+	@rm -rf ./__pycache__
+	@rm -f  $(SRC_CORE)/*.pyc
+	@rm -rf $(SRC_CORE)/__pycache__
+	@rm -f  $(SRC_TEST)/*.pyc
+	@rm -rf $(SRC_TEST)/__pycache__
+	@rm -f  $(SRC_EXAMPLES)/*.pyc
+	@rm -rf $(SRC_EXAMPLES)/__pycache__
+	@rm -rf $(SRC_EXAMPLES)/build
+	@rm -rf ./.coverage
+	@rm -rf ./coverage.xml
+	@rm -rf ./.pytest_cache
+	@rm -rf ./.mypy_cache
+	@rm -rf ./site
+	@rm -rf ./reports
+
 .PHONY: setup
-setup:
-	python3 -m venv .env
-	.env/bin/pip install --upgrade pip
+setup: ## Setup virtual environment
+	$(PYTHON) -m venv .env
+	.env/bin/pip install --upgrade pip wheel
 	.env/bin/pip install --upgrade --requirement requirements.txt
 	.env/bin/pip install --upgrade --requirement requirements-dev.txt
 	.env/bin/pip install --upgrade --requirement requirements-examples.txt
 
 .PHONY: install
-install: setup
+install: setup ## install package
 	.env/bin/pip install .
 
 .PHONY: lint
-lint:
-	.env/bin/pylint \
-	    setup.py staticmaps examples tests
+lint: ## Lint the code
+	.env/bin/pycodestyle \
+		--max-line-length=120 \
+		setup.py $(SRC_COMPLETE)
+	.env/bin/isort \
+		setup.py $(SRC_COMPLETE) \
+		--check --diff
+	.env/bin/black \
+		--line-length 120 \
+		--check \
+		--diff \
+		setup.py $(SRC_COMPLETE)
+	.env/bin/pyflakes \
+		setup.py $(SRC_COMPLETE)
 	.env/bin/flake8 \
-	    setup.py staticmaps examples tests
+		setup.py $(SRC_COMPLETE)
+	.env/bin/pylint \
+		setup.py $(SRC_COMPLETE)
 	.env/bin/mypy \
-	    setup.py staticmaps examples tests
-	.env/bin/black \
-	    --line-length 120 \
-	    --check \
-	    --diff \
-	    setup.py staticmaps examples tests
+		setup.py $(SRC_COMPLETE)
+	.env/bin/codespell  \
+		README.md staticmaps/*.py tests/*.py examples/*.py
 
 .PHONY: format
-format:
+format: ## Format the code
+	.env/bin/isort \
+		setup.py $(SRC_COMPLETE)
+	.env/bin/autopep8 \
+		-i -r \
+		setup.py $(SRC_COMPLETE)
 	.env/bin/black \
-	    --line-length 120 \
-	    setup.py staticmaps examples tests
+		--line-length 120 \
+		setup.py $(SRC_COMPLETE)
 
 .PHONY: run-examples
-run-examples:
+run-examples: ## Generate example images
+	(cd examples && rm -r build)
 	(cd examples && PYTHONPATH=.. ../.env/bin/python custom_objects.py)
 	(cd examples && PYTHONPATH=.. ../.env/bin/python draw_gpx.py running.gpx)
 	(cd examples && PYTHONPATH=.. ../.env/bin/python frankfurt_newyork.py)
@@ -40,24 +90,35 @@ run-examples:
 	(cd examples && PYTHONPATH=.. ../.env/bin/python tile_providers.py)
 	(cd examples && PYTHONPATH=.. ../.env/bin/python us_capitals.py)
 	(cd examples && PYTHONPATH=.. ../.env/bin/python idl.py)
-	(cd examples && mv *.svg build/.)
-	(cd examples && mv *pillow*png build/.)
-	(cd examples && mv *cairo*png build/.)
-	(cd -)
+	(cd examples && mkdir -p build)
+	(cd examples && ls        *.svg 2>/dev/null && mv        *.svg build/.) || echo "no svg files found!"
+	(cd examples && ls *pillow*.png 2>/dev/null && mv *pillow*.png build/.) || echo "no pillow png files found!"
+	(cd examples && ls  *cairo*.png 2>/dev/null && mv  *cairo*.png build/.) || echo "no cairo png files found!"
+
 .PHONY: test
-test:
+test: ## Test the code
 	PYTHONPATH=. .env/bin/python -m pytest tests
 
+.PHONY: coverage
+coverage: ## Generate coverage report for the code
+	PYTHONPATH=. .env/bin/python -m pytest --cov=staticmaps --cov-branch --cov-report=term --cov-report=html tests
+
 .PHONY: build-package
-build-package:
+build-package: ## Build the package
 	rm -rf dist
 	PYTHONPATH=. .env/bin/python setup.py sdist
 	PYTHONPATH=. .env/bin/twine check dist/*
 
 .PHONY: upload-package-test
-upload-package-test:
+upload-package-test: ## Upload package test
 	PYTHONPATH=. .env/bin/twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 
 .PHONY: upload-package
-upload-package:
+upload-package: ## Upload package
 	PYTHONPATH=. .env/bin/twine upload --repository py-staticmaps dist/*
+
+.PHONY: documentation
+documentation: ## Generate documentation
+	@if type mkdocs >/dev/null 2>&1 ; then .env/bin/python -m mkdocs build --clean --verbose ; \
+	 else echo "SKIPPED. Run '.env/bin/python -m install mkdocs' first." >&2 ; fi 
+