swapi-client 0.2.2__tar.gz

swapi_client-0.2.2/.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: "Publish"
+
+on:
+  release:
+    types: ["published"]
+
+jobs:
+  run:
+    name: "Build and publish release"
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: '3.12'
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        run: uv publish --token ${{ secrets.PYPI_TOKEN }}

swapi_client-0.2.2/.github/workflows/release.yml

@@ -0,0 +1,57 @@
+name: Create Release
+
+on:
+    push:
+        branches:
+            - master
+        paths-ignore:
+            - README.md
+            - .gitignore
+
+jobs:
+    release:
+        name: Create Release
+        runs-on: ubuntu-latest
+
+        steps:
+            -   name: Check out the repo
+                uses: actions/checkout@v4.1.7
+                with:
+                    token: ${{ secrets.RELEASE_GIT_TOKEN }}
+            -   name: Update version in pyproject.toml
+                id: version_bump
+                run: |
+                    OLD_VERSION=$(awk -F ' = ' '/^version =/ {gsub(/"/, "", $2); print $2}' pyproject.toml)
+                    
+                    IFS='.' read -r -a V_PARTS <<< "$OLD_VERSION"
+                    V_PARTS[2]=$((V_PARTS[2] + 1))
+                    NEW_VERSION="${V_PARTS[0]}.${V_PARTS[1]}.${V_PARTS[2]}"
+                    
+                    # Using awk for safer replacement
+                    awk -v old="version = \"$OLD_VERSION\"" -v new="version = \"$NEW_VERSION\"" '{gsub(old, new)}1' pyproject.toml > pyproject.toml.tmp && mv pyproject.toml.tmp pyproject.toml
+                    
+                    echo "New version: $NEW_VERSION"
+                    echo "VERSION=$NEW_VERSION" >> "$GITHUB_OUTPUT"
+            -   name: Commit and push changes
+                run: |
+                    git config --global user.email "github@actions.com"
+                    git config --global user.name "GitHub Actions"
+                    git add pyproject.toml
+                    if [[ -n "$(git diff --cached)" ]]; then
+                        git commit -m "Bump version to ${{ steps.version_bump.outputs.VERSION }} [skip ci]"
+                        git push
+                    else
+                        echo "No changes to commit"
+                    fi
+            -   name: Extract version from pyproject.toml
+                id: extract_metadata
+                run: |
+                    VERSION=$(awk -F ' = ' '/^version =/ {gsub(/"/, "", $2); print $2}' ./pyproject.toml)
+                    echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+                shell: bash
+            -   name: Release New Version
+                uses: softprops/action-gh-release@v1
+                with:
+                    name: v${{ steps.extract_metadata.outputs.version }}
+                    tag_name: v${{ steps.extract_metadata.outputs.version }}
+                    token: ${{ secrets.RELEASE_GIT_TOKEN }}

swapi_client-0.2.2/.gitignore

@@ -0,0 +1,196 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,visualstudiocode
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,visualstudiocode
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/python,visualstudiocode
+main.py

swapi_client-0.2.2/.python-version

@@ -0,0 +1 @@
+3.12

swapi_client-0.2.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 qwizi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

swapi_client-0.2.2/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: swapi-client
+Version: 0.2.2
+Summary: API client for Serwis Planner
+Project-URL: Homepage, https://github.com/qwizi/swapi-client
+Project-URL: Bug Tracker, https://github.com/qwizi/swapi-client/issues
+Author-email: qwizi <qwizi@qwizi.dev>
+License: MIT License
+        
+        Copyright (c) 2025 qwizi
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: python-dotenv>=1.0.1
+Description-Content-Type: text/markdown
+
+# SW-API-Client
+
+An asynchronous Python client for the Serwis Planner API.
+
+## Features
+
+-   Asynchronous design using `httpx` and `asyncio`.
+-   Token-based authentication.
+-   Helper methods for all major API endpoints.
+-   Generic helpers for `meta`, `autoselect`, `history`, and `audit` endpoints.
+-   Pagination helper (`get_all_pages`) to easily fetch all results from paginated endpoints.
+-   Powerful `SWQueryBuilder` for creating complex queries with filtering, sorting, and field selection.
+-   No Pydantic models required; uses plain Python dictionaries for all data.
+
+## Installation
+
+First, install the package from PyPI:
+
+```bash
+pip install swapi-client
+```
+
+The client uses `python-dotenv` to manage environment variables for the example. Install it if you want to run the example code directly.
+
+```bash
+pip install python-dotenv
+```
+
+## Usage
+
+### Configuration
+
+Create a `.env` file in your project root to store your API credentials:
+
+```env
+SW_API_URL=https://your-api-url.com
+SW_CLIENT_ID=your_client_id
+SW_AUTH_TOKEN=your_auth_token
+SW_LOGIN=your_login_email
+SW_PASSWORD=your_password
+```
+
+### Example
+
+Here is a complete example demonstrating how to log in, fetch data, and use the query builder.
+
+```python
+import asyncio
+import os
+import pprint
+from dotenv import load_dotenv
+from swapi_client import SWApiClient, SWQueryBuilder
+
+# Load environment variables from .env file
+load_dotenv()
+
+async def main():
+    """
+    Main function to demonstrate the usage of the SWApiClient.
+    """
+    api_url = os.getenv("SW_API_URL")
+    client_id = os.getenv("SW_CLIENT_ID")
+    auth_token = os.getenv("SW_AUTH_TOKEN")
+    login_user = os.getenv("SW_LOGIN")
+    password = os.getenv("SW_PASSWORD")
+
+    if not all([api_url, client_id, auth_token, login_user, password]):
+        print("Please set all required environment variables in a .env file.")
+        return
+
+    # The client is used within an async context manager
+    async with SWApiClient(api_url) as client:
+        try:
+            # 1. Login to get an authentication token
+            print("Attempting to log in...")
+            token = await client.login(
+                clientId=client_id,
+                authToken=auth_token,
+                login=login_user,
+                password=password,
+            )
+            print(f"Successfully logged in. Token starts with: {token[:10]}...")
+
+            # 2. Verify the token and get current user info
+            me = await client.get_me()
+            print(f"Token verified. Logged in as: {me.get('user', {}).get('username')}")
+            print("-" * 30)
+
+            # 3. Example: Get all account companies using the pagination helper
+            print("Fetching all account companies (with pagination)...")
+            all_companies = await client.get_all_pages(client.get_account_companies)
+            print(f"Found a total of {len(all_companies)} companies.")
+            if all_companies:
+                print(f"First company: {all_companies[0].get('name')}")
+            print("-" * 30)
+
+            # 4. Example: Use the SWQueryBuilder to filter, sort, and select fields
+            print("Fetching filtered companies...")
+            query = (
+                SWQueryBuilder()
+                .filter("name", "STB", "contains")
+                .order("name", "asc")
+                .fields(["id", "name", "email"])
+                .page_limit(5)
+            )
+            filtered_companies_response = await client.get_account_companies(query_builder=query)
+            filtered_companies = filtered_companies_response.get('data', [])
+            print(f"Found {len(filtered_companies)} companies matching the filter.")
+            pprint.pprint(filtered_companies)
+            print("-" * 30)
+
+            # 5. Example: Get metadata for a module
+            print("Fetching metadata for the 'products' module...")
+            products_meta = await client.get_entity_meta("products")
+            print("Available fields for products (first 5):")
+            for field, details in list(products_meta.get('data', {}).get('fields', {}).items())[:5]:
+                 print(f"  - {field}: {details.get('label')}")
+            print("-" * 30)
+
+            # 6. Example: Use for_metadata to get dynamic metadata
+            print("Fetching metadata for a serviced product with specific attributes...")
+            meta_query = SWQueryBuilder().for_metadata({"id": 1, "commissionPhase": 1})
+            serviced_product_meta = await client.get_entity_meta(
+                "serviced_products", query_builder=meta_query
+            )
+            print("Metadata for serviced product with for[id]=1 and for[commissionPhase]=1:")
+            pprint.pprint(serviced_product_meta.get('data', {}).get('fields', {}).get('commission'))
+
+        except Exception as e:
+            print(f"An error occurred: {e}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## SWQueryBuilder
+
+The `SWQueryBuilder` provides a fluent interface to construct complex query parameters for the API.
+
+| Method                                | Description                                                                                             |
+| ------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| `fields(["field1", "field2"])`        | Specifies which fields to include in the response.                                                      |
+| `extra_fields(["field1"])`            | Includes additional, non-default fields.                                                                |
+| `for_metadata({"id": 1})`             | Simulates an object change to retrieve dynamic metadata (uses `for[fieldName]`).                        |
+| `order("field", "desc")`              | Sorts the results by a field in a given direction (`asc` or `desc`).                                    |
+| `page_limit(50)`                      | Sets the number of results per page.                                                                    |
+| `page_offset(100)`                    | Sets the starting offset for the results.                                                               |
+| `page_number(3)`                      | Sets the page number to retrieve.                                                                       |
+| `filter("field", "value", "op")`      | Adds a filter condition. Operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `in`, `isNull`, etc. |
+| `filter_or({...}, group_index=0)`     | Adds a group of conditions where at least one must be true.                                             |
+| `filter_and({...}, group_index=0)`    | Adds a group of conditions where all must be true.                                                      |
+| `with_relations(True)`                | Includes related objects in the response.                                                               |
+| `with_editable_settings_for_action()` | Retrieves settings related to a specific action.                                                        |
+| `lang("en")`                          | Sets the language for the response.                                                                     |
+| `build()`                             | Returns the dictionary of query parameters.                                                             |
+
+## API Methods
+
+The client provides a comprehensive set of methods for interacting with the Serwis Planner API. It includes specific methods for most endpoints (e.g., `get_products`, `create_account_user`) as well as generic helpers.
+
+### Generic Helpers
+
+-   `get_all_pages(paginated_method, ...)`: Automatically handles pagination for any list endpoint.
+-   `get_entity_meta(module, ...)`: Fetches metadata for any module.
+-   `get_entity_autoselect(module, ...)`: Fetches autoselect data for any module.
+-   `get_entity_history(module, ...)`: Fetches history records for any module.
+-   `get_entity_audit(module, ...)`: Fetches audit records for any module.
+
+### Major Endpoints Covered
+
+-   Account Companies
+-   Account Users
+-   Products & Serviced Products
+-   Baskets & Basket Positions
+-   Commissions
+-   File Uploads
+-   ODBC Reports
+-   Email Messages
+-   PDF Generation
+-   History and Auditing
+-   Bulk and Contextual Operations
+-   Global Search
+-   And many more...
+
+Each endpoint has corresponding `get`, `create`, `update`, `patch`, and `delete` methods where applicable. For a full list of available methods, please refer to the source code in `src/swapi_client/client.py`.