diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml new file mode 100644 index 0000000..0d78aa5 --- /dev/null +++ b/.github/workflows/pythonpackage.yml @@ -0,0 +1,40 @@ +# This workflow will install Python dependencies, run tests and lint with a variety of Python versions +# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions + +name: Python package + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [3.5, 3.6, 3.7, 3.8] + + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + - name: Lint with flake8 + run: | + pip install flake8 + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Test with pytest + run: | + pip install pytest + pytest diff --git a/docs/source/django_integration.rst b/docs/source/django_integration.rst index d3ced2b..1dd1dc4 100644 --- a/docs/source/django_integration.rst +++ b/docs/source/django_integration.rst @@ -15,7 +15,7 @@ If you want to use default (global) object, skip this step. In most cases it is from jsonrpc.backend.django import api -If you would like to use different api versions (not, you could name methods differently) or use cudtom dispatcher, use +If you would like to use different api versions (not, you could name methods differently) or use custom dispatcher, use .. code-block:: python diff --git a/docs/source/flask_integration.rst b/docs/source/flask_integration.rst index 66dcf1c..a4b7638 100644 --- a/docs/source/flask_integration.rst +++ b/docs/source/flask_integration.rst @@ -1,7 +1,7 @@ Integration with Flask ====================== -.. note:: Flask backend is optionaly supported. Library itself does not depend on Flask. +.. note:: Flask backend is optionally supported. Library itself does not depend on Flask. Create api instance ------------------- @@ -25,7 +25,7 @@ Later on we assume that you use default api instance. Add api endpoint to the project ------------------------------- -You have to options to add new endpoint to your Flask application. +You have two options to add new endpoint to your Flask application. First - register as a blueprint. In this case, as small bonus, you got a /map handler, which prints all registered methods.

AltStyle によって変換されたページ (->オリジナル) /