Merge pull request #175 from lumapps/MP-685/application-auth

Mp 685/application auth

Author: theo-ardouin

.github/workflows/ci.yml

@@ -12,15 +12,18 @@ jobs:
 
     steps:
       - name: Checkout branch
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v2
 
-      - name: Setup Python 3.6 🐍
-        uses: actions/setup-python@v2.1.4
+      - name: Setup Python 🐍
+        uses: actions/setup-python@v2
         with:
-          python-version: 3.6
+          python-version: 3.7
 
       - name: Install Poetry
-        uses: snok/[email protected]
+        uses: snok/install-poetry@5e4414407e59f94f2148bcb253917dfc22dee7d9
+        with:
+          virtualenvs-in-project: false
+          virtualenvs-path: ~/.cache/poetry/virtualenvs
 
       - uses: actions/cache@v1
         name: Cache Poetry deps
@@ -30,38 +33,36 @@ jobs:
           restore-keys: |
             lint-${{ runner.os }}-poetry-
 
-      - name: Set Poetry config
-        run: |
-          poetry config virtualenvs.in-project false
-          poetry config virtualenvs.path ~/.cache/poetry/virtualenvs
-
       - name: Install Dependencies
         run: poetry install -v
         if: steps.cache.outputs.cache-hit != 'true'
 
       - name: Check the code quality
-        run: make check-code-quality
+        run: POETRY=poetry make check-code-quality
 
       - name: Check if the code is correctly typed
-        run: make check-types
+        run: POETRY=poetry make check-types
 
   Tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.7, 3.8, 3.9]
 
     steps:
       - name: Checkout branch
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v2
 
       - name: Setup Python ${{ matrix.python-version }} 🐍
-        uses: actions/setup-python@v2.1.4
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install Poetry
-        uses: snok/[email protected]
+        uses: snok/install-poetry@5e4414407e59f94f2148bcb253917dfc22dee7d9
+        with:
+          virtualenvs-in-project: false
+          virtualenvs-path: ~/.cache/poetry/virtualenvs
 
       - uses: actions/cache@v1
         name: Cache Poetry deps
@@ -71,21 +72,16 @@ jobs:
           restore-keys: |
             tests-${{ runner.os }}-${{ matrix.python-version }}-poetry-
 
-      - name: Set Poetry config
-        run: |
-          poetry config virtualenvs.in-project false
-          poetry config virtualenvs.path ~/.cache/poetry/virtualenvs
-
       - name: Install Dependencies
         run: poetry install -v
         if: steps.cache.outputs.cache-hit != 'true'
 
       - name: Run the test suite
-        run: make test
+        run: POETRY=poetry make test
 
       - name: Upload coverage to Codecov
         if: matrix.python-version == 3.7
-        uses: codecov/codecov-action@v1.0.15
+        uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.xml

.github/workflows/github-actions-validator.yml

@@ -0,0 +1,12 @@
+name: "CI: github-actions-validator"
+
+on:
+  pull_request:
+
+jobs:
+  github-actions-validator:
+    name: Github-actions-validator
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: lumapps/[email protected]

.github/workflows/pypi-publish.yml

@@ -18,13 +18,16 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Setup Python 3.7 🐍
-        uses: actions/setup-python@v2.1.4
+      - name: Setup Python 🐍
+        uses: actions/setup-python@v2
         with:
           python-version: 3.7
-      
+
       - name: Install Poetry
-        uses: snok/[email protected]
+        uses: snok/install-poetry@5e4414407e59f94f2148bcb253917dfc22dee7d9
+        with:
+          virtualenvs-in-project: false
+          virtualenvs-path: ~/.cache/poetry/virtualenvs
 
       - uses: actions/cache@v1
         name: Cache Poetry deps
@@ -38,11 +41,6 @@ jobs:
         run: |
           git config --local user.email "[email protected]"
           git config --local user.name "GitHub Action"
-
-      - name: Set Poetry config
-        run: |
-          poetry config virtualenvs.in-project false
-          poetry config virtualenvs.path ~/.cache/poetry/virtualenvs
       
       - name: Install Dependencies
         run: poetry install -v --no-interaction
@@ -61,15 +59,15 @@ jobs:
           git commit -m "chore(release): release version ${{ github.event.release.tag_name }}"
       
       - name: Push changes
-        uses: ad-m/github-push-action@master
+        uses: ad-m/github-push-action@40bf560936a8022e68a3c00e7d2abefaf01305a6
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build doc
-        run: make docs
+        run: POETRY=poetry make docs
 
       - name: Publish doc
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./site
+          publish_dir: ./site

.github/workflows/pypi.yml

@@ -16,13 +16,16 @@ jobs:
       - name: Checkout branch
         uses: actions/[email protected]
 
-      - name: Setup Python 3.7 🐍
-        uses: actions/setup-python@v2.1.4
+      - name: Setup Python 🐍
+        uses: actions/setup-python@v2
         with:
           python-version: 3.7
-      
+
       - name: Install Poetry
-        uses: snok/[email protected]
+        uses: snok/install-poetry@5e4414407e59f94f2148bcb253917dfc22dee7d9
+        with:
+          virtualenvs-in-project: false
+          virtualenvs-path: ~/.cache/poetry/virtualenvs
 
       - uses: actions/cache@v1
         name: Cache Poetry deps
@@ -31,16 +34,10 @@ jobs:
           key: pypi-${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
           restore-keys: |
             pypi-${{ runner.os }}-poetry-
-              
-      - name: Set Poetry config
-        run: |
-          poetry config virtualenvs.in-project false
-          poetry config virtualenvs.path ~/.cache/poetry/virtualenvs
-      
+
       - name: Install Dependencies
         run: poetry install -v
         if: steps.cache.outputs.cache-hit != 'true'
 
       - name: Check that package build
         run: poetry build
-      

.github/workflows/release-note.yml

@@ -1,4 +1,3 @@
-
 name: Create release note
 
 on:
@@ -14,13 +13,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v2
         with:
           fetch-depth: 0
-          
+
       - name: Generate changelog
         id: generate_changelog
-        uses: sebastien-boulle/changelog-generator@master
+        uses: lumapps/changelog-generator@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -34,4 +33,4 @@ jobs:
           release_name: Release ${{ github.ref }}
           body: ${{ steps.generate_changelog.outputs.changelog }}
           draft: true
-          prerelease: false
+          prerelease: false

.gitignore

@@ -22,6 +22,7 @@ http_cache.sqlite
 # virtualenv
 env/
 venv/
+.venv/
 
 
 # doc

CONTRIBUTING.md

@@ -10,10 +10,16 @@ First install dependencies and setup pre-commits hooks
 make setup
 ```
 
+To setup using a different version of python, you may use the following:
+
+```bash
+PYTHON=python3.X make setup
+```
+
 Then to go in the poetry virtual env do
 
 ```
-poetry shell
+source .venv/bin/activate
 ```
 
 You can run `make help` to see all available actions !

Makefile

@@ -1,26 +1,24 @@
 .DEFAULT_GOAL := help
+.PHONY: check check-code-quality check-docs check-types clean docs-cp docs docs-serve docs-deploy help format setup test
 
 PY_SRC := lumapps/
 CI ?= false
 TESTING ?= false
+PYTHON ?= python3.7
+PIP = .venv/bin/pip
+POETRY ?= .venv/bin/poetry
 
-.PHONY: check
 check: check-docs check-code-quality check-types  ## Check it all!
 
-.PHONY: check-code-quality
 check-code-quality:  ## Check the code quality.
-	@poetry run failprint -t "Checking code quality" -- flake8 --config=config/flake8.ini $(PY_SRC)
+	@$(POETRY) run failprint -t "Checking code quality" -- flake8 --config=config/flake8.ini $(PY_SRC)
 
-
-.PHONY: check-docs
 check-docs:  ## Check if the documentation builds correctly.
-	@poetry run failprint -t "Building documentation" -- mkdocs build -s
+	@$(POETRY) run failprint -t "Building documentation" -- mkdocs build -s
 
-.PHONY: check-types
 check-types:  ## Check that the code is correctly typed.
-	@poetry run failprint -t "Type-checking" -- mypy --config-file config/mypy.ini $(PY_SRC)
+	@$(POETRY) run failprint -t "Type-checking" -- mypy --config-file config/mypy.ini $(PY_SRC)
 
-.PHONY: clean
 clean:  ## Delete temporary files.
 	@rm -rf build 2>/dev/null
 	@rm -rf .coverage* 2>/dev/null
@@ -33,54 +31,37 @@ clean:  ## Delete temporary files.
 	@rm -rf tests/__pycache__ 2>/dev/null
 	@find . -name "*.rej" -delete 2>/dev/null
 
-.PHONY: docs-cp
 docs-cp:
 	cp README.md docs/index.md
 	cp LICENSE.md docs/
 
-.PHONY: docs
 docs: docs-cp ## Build the documentation locally.
-	@poetry run mkdocs build
+	@$(POETRY) run mkdocs build
 
-.PHONY: docs-serve
 docs-serve: docs-cp ## Serve the documentation (localhost:8000).
-	@poetry run mkdocs serve
+	@$(POETRY) run mkdocs serve
 
-.PHONY: docs-deploy
 docs-deploy: docs-cp ## Deploy the documentation on GitHub pages.
-	@poetry run mkdocs gh-deploy
+	@$(POETRY) run mkdocs gh-deploy
 
-.PHONY: help
 help:  ## Print this help.
 	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9_-]+:.*?## / {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
 
-.PHONY: format
 format:  ## Run formatting tools on the code.
-	@poetry run failprint -t "Formatting code" -- black $(PY_SRC)
-	@poetry run failprint -t "Ordering imports" -- isort -y -rc $(PY_SRC)
-
+	@$(POETRY) run failprint -t "Formatting code" -- black $(PY_SRC)
+	@$(POETRY) run failprint -t "Ordering imports" -- isort -y -rc $(PY_SRC)
 
-.PHONY: setup
-setup:  ## Setup the development environment (install dependencies).
-	@if ! $(CI); then \
-		if ! command -v pipx &>/dev/null; then \
-			pip install pipx; \
-		fi; \
-		if ! command -v poetry &>/dev/null; then \
-		  pipx install poetry; \
-		fi; \
-	fi; \
-	poetry config virtualenvs.in-project true
-	poetry install -v
-	@if ! $(CI); then \
-		poetry run pre-commit install; \
-		poetry run pre-commit install --hook-type commit-msg; \
-	fi; \
+setup: .venv  ## Setup the development environment (install dependencies).
+	$(POETRY) config virtualenvs.in-project true
+	$(POETRY) install -v
+	$(POETRY) run pre-commit install
+	$(POETRY) run pre-commit install --hook-type commit-msg
 
-
-.PHONY: test
 test:  ## Run the test suite and report coverage. 2>/dev/null
-	@poetry run pytest -c config/pytest.ini
-	@poetry run coverage html --rcfile=config/coverage.ini
-
+	@$(POETRY) run pytest -c config/pytest.ini
+	@$(POETRY) run coverage html --rcfile=config/coverage.ini
 
+.venv:  ## Install the virtual env directory
+	$(PYTHON) -m venv .venv
+	$(PIP) install --quiet --upgrade pip
+	$(PIP) install poetry

README.md

@@ -19,13 +19,15 @@ This includes:
 
 ## Installation
 
-
 ```bash
 pip install lumapps-sdk
 ```
 
-## Getting started
+## Requirements
 
+Python >= 3.7
+
+## Getting started
 
 1. Get your token
 
@@ -77,7 +79,4 @@ Please refer to our [contributing guidelines](CONTRIBUTING.md).
 
 ## Copyright and license
 
-
 LumApps SDK is released under the [MIT license](LICENSE.md).
-
-

config/mypy.ini

@@ -2,4 +2,4 @@
 ignore_missing_imports = true
 
 [mypy-lumapps.api.client]
-ignore_errors = True
+ignore_errors = true