Merge pull request #313 from linode/dev

Release v5.7.0

Author: lgarber-akamai

.github/workflows/e2e-test-pr.yml

@@ -81,7 +81,7 @@ jobs:
       - run: make INTEGRATION_TEST_PATH="${{ inputs.test_path }}" testint
         if: ${{ steps.validate-tests.outputs.match == '' }}
         env:
-          LINODE_CLI_TOKEN: ${{ secrets.LINODE_TOKEN }}
+          LINODE_TOKEN: ${{ secrets.LINODE_TOKEN }}
 
       - uses: actions/github-script@v6
         id: update-check-run

.github/workflows/lint.yml

@@ -18,7 +18,7 @@ jobs:
           python-version: '3.x'
 
       - name: install dependencies
-        run: pip3 install -r requirements-dev.txt -r requirements.txt
+        run: make requirements
 
       - name: run linter
         run: make lint

.github/workflows/main.yml

@@ -16,8 +16,8 @@ jobs:
       matrix:
         python-version: ['3.7','3.8','3.9','3.10','3.11']
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Run tests

.github/workflows/nightly-smoke-tests.yml

@@ -0,0 +1,35 @@
+name: Nightly Smoke Tests
+
+on:
+  schedule:
+    - cron: "0 0 * * *"
+  workflow_dispatch:
+
+jobs:
+  smoke_tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: dev
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install Python deps
+        run: pip install -r requirements.txt -r requirements-dev.txt wheel boto3
+
+      - name: Install Python SDK
+        run: make install
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run smoke tests
+        run: |
+          make smoketest
+        env:
+          LINODE_TOKEN: ${{ secrets.LINODE_TOKEN }}

.github/workflows/publish-pypi.yaml

@@ -24,9 +24,6 @@ jobs:
       - name: Install Python deps
         run: pip install -U wheel build certifi
 
-      - name: Install package requirements
-        run: make requirements
-
       - name: Build the package
         run: make build
         env:

CODEOWNERS

@@ -0,0 +1,2 @@
+* @linode/dx
+

Makefile

@@ -27,36 +27,41 @@ build: clean
 release: build
 	twine upload dist/*
 
-
+@PHONEY: install
 install: clean
 	python3 -m pip install .
 
-
+@PHONEY: requirements
 requirements:
 	pip install -r requirements.txt -r requirements-dev.txt
 
-
+@PHONEY: black
 black:
 	black linode_api4 test
 
-
+@PHONEY: isort
 isort:
 	isort linode_api4 test
 
-
+@PHONEY: autoflake
 autoflake:
 	autoflake linode_api4 test
 
-
+@PHONEY: format
 format: black isort autoflake
 
-
-lint:
+@PHONEY: lint
+lint: build
 	isort --check-only linode_api4 test
 	autoflake --check linode_api4 test
 	black --check --verbose linode_api4 test
 	pylint linode_api4
+	twine check dist/*
 
 @PHONEY: testint
 testint:
 	python3 -m pytest test/integration/${INTEGRATION_TEST_PATH}${MODEL_COMMAND} ${TEST_CASE_COMMAND}
+
+@PHONEY: smoketest
+smoketest:
+	pytest -m smoke test/integration --disable-warnings

README.rst

@@ -140,7 +140,7 @@ Integration tests live in the ``test/integration`` directory.
 
 Pre-requisite
 ^^^^^^^^^^^^^^^^^
-Export Linode API token as `LINODE_CLI_TOKEN` before running integration tests::
+Export Linode API token as `LINODE_TOKEN` before running integration tests::
 
     export LINODE_TOKEN = $(your_token)
 

docs/guides/core_concepts.rst

@@ -49,12 +49,13 @@ certain group.  This library implements filtering with a SQLAlchemy-like
 syntax, where a model's attributes may be used in comparisons to generate
 filters.  For example::
 
+   from linode_api4 import Instance
+
    prod_linodes = client.linode.instances(Instance.group == "production")
 
 Filters may be combined using boolean operators similar to SQLAlchemy::
 
    # and_ and or_ can be imported from the linode package to combine filters
-   from linode_api4 import or_
    prod_or_staging = client.linode.instances(or_(Instance.group == "production",
                                                      Instance.group == "staging"))
 
@@ -66,7 +67,7 @@ Filters may be combined using boolean operators similar to SQLAlchemy::
 Filters are generally only applicable for the type of model you are querying,
 but can be combined to your heart's content.  For numeric fields, the standard
 numeric comparisons are accepted, and work as you'd expect.  See
-:doc:`Filtering Collections<../linode/objects/filtering>` for full details.
+:doc:`Filtering Collections</linode_api4/objects/filtering>` for full details.
 
 Models
 ------

linode_api4/groups/account.py

@@ -49,6 +49,8 @@ def events(self, *filters):
         API Documentation: https://www.linode.com/docs/api/account/#events-list
 
         :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
 
         :returns: A list of events on the current account matching the given filters.
         :rtype: PaginatedList of Event
@@ -124,6 +126,8 @@ def oauth_clients(self, *filters):
         API Documentation: https://www.linode.com/docs/api/account/#oauth-clients-list
 
         :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
 
         :returns: A list of OAuth Clients associated with this account.
         :rtype: PaginatedList of OAuthClient
@@ -167,6 +171,8 @@ def users(self, *filters):
         API Documentation: https://www.linode.com/docs/api/account/#users-list
 
         :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
 
         :returns: A list of users on this account.
         :rtype: PaginatedList of User