Update README.md #1406
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # 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: Package | |
| on: | |
| push: | |
| branches: [ "master" ] | |
| pull_request: {} | |
| env: | |
| PYTHON_VERSION: "3.9.14" | |
| jobs: | |
| bandit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| test-requirements: "true" | |
| - name: Run bandit | |
| run: bandit --ini .bandit -r instagrapi | |
| flake8: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| test-requirements: "true" | |
| - name: Run flake8 | |
| run: | | |
| # 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 --statistics | |
| isort: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| requirements: "true" | |
| test-requirements: "true" | |
| - name: Run isort | |
| run: isort --check-only instagrapi | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: [ 3.8, 3.9 ] | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| requirements: "true" | |
| test-requirements: "true" | |
| - name: Run test | |
| run: python -m unittest tests.FakeClientTestCase | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'pull_request' | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| requirements: "true" | |
| test-requirements: "true" | |
| - name: Build Docs | |
| run: mkdocs build --strict | |
| # upload artifact for dev build | |
| - name: Upload coverage results artifact | |
| if: github.ref != 'refs/heads/main' | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: docs-site | |
| path: site/ | |
| update-dev-docs: | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| with: | |
| requirements: "true" | |
| test-requirements: "true" | |
| - name: Push documentaiton changes | |
| uses: ./.github/actions/publish-docs-with-mike | |
| with: | |
| version_name: dev |