queueflow 0.1.0__tar.gz

queueflow-0.1.0/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: queueflow
+Version: 0.1.0
+Summary: QueueFlow API
+Home-page: https://github.com/queueflow/queueflow-sdk-python
+Author: QueueFlow
+Author-email: team@queueflow.dev
+License: MIT
+Keywords: OpenAPI,OpenAPI-Generator,QueueFlow API
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=1.25.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+    REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
+    

queueflow-0.1.0/README.md

@@ -0,0 +1,188 @@
+# queueflow
+REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 0.1.0
+- Generator version: 7.10.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+For more information, please visit [https://queueflow.dev](https://queueflow.dev)
+
+## Requirements.
+
+Python 3.8+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import queueflow
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import queueflow
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import queueflow
+from queueflow.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost:8000
+# See configuration.py for a list of all supported configuration parameters.
+configuration = queueflow.Configuration(
+    host = "http://localhost:8000"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (API Key): bearerAuth
+configuration = queueflow.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+
+# Enter a context with an instance of the API client
+with queueflow.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = queueflow.CronApi(api_client)
+    create_cron_request = queueflow.CreateCronRequest() # CreateCronRequest | 
+
+    try:
+        api_response = api_instance.create_cron(create_cron_request)
+        print("The response of CronApi->create_cron:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling CronApi->create_cron: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost:8000*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CronApi* | [**create_cron**](docs/CronApi.md#create_cron) | **POST** /api/v1/cron | 
+*CronApi* | [**delete_cron**](docs/CronApi.md#delete_cron) | **DELETE** /api/v1/cron/{id} | 
+*CronApi* | [**get_cron**](docs/CronApi.md#get_cron) | **GET** /api/v1/cron/{id} | 
+*CronApi* | [**list_crons**](docs/CronApi.md#list_crons) | **GET** /api/v1/cron | 
+*CronApi* | [**pause_cron**](docs/CronApi.md#pause_cron) | **POST** /api/v1/cron/{id}/pause | 
+*CronApi* | [**resume_cron**](docs/CronApi.md#resume_cron) | **POST** /api/v1/cron/{id}/resume | 
+*DlqApi* | [**get_dead_letter**](docs/DlqApi.md#get_dead_letter) | **GET** /api/v1/dlq/{id} | 
+*DlqApi* | [**list_dead_letters**](docs/DlqApi.md#list_dead_letters) | **GET** /api/v1/dlq | 
+*DlqApi* | [**replay_dead_letter**](docs/DlqApi.md#replay_dead_letter) | **POST** /api/v1/dlq/{id}/replay | 
+*HealthApi* | [**get_health**](docs/HealthApi.md#get_health) | **GET** /health | 
+*HealthApi* | [**get_ready**](docs/HealthApi.md#get_ready) | **GET** /ready | 
+*JobsApi* | [**cancel_job**](docs/JobsApi.md#cancel_job) | **POST** /api/v1/jobs/{id}/cancel | 
+*JobsApi* | [**create_batch_jobs**](docs/JobsApi.md#create_batch_jobs) | **POST** /api/v1/jobs/batch | 
+*JobsApi* | [**create_job**](docs/JobsApi.md#create_job) | **POST** /api/v1/jobs | 
+*JobsApi* | [**get_job**](docs/JobsApi.md#get_job) | **GET** /api/v1/jobs/{id} | 
+*JobsApi* | [**list_jobs**](docs/JobsApi.md#list_jobs) | **GET** /api/v1/jobs | 
+*JobsApi* | [**stream_job_events**](docs/JobsApi.md#stream_job_events) | **GET** /api/v1/jobs/{id}/events | Stream a job's status transitions as Server-Sent Events until it reaches a terminal state. Lets clients await completion without polling the REST endpoint themselves.
+*SystemApi* | [**get_stats**](docs/SystemApi.md#get_stats) | **GET** /api/v1/stats | 
+*SystemApi* | [**list_tasks**](docs/SystemApi.md#list_tasks) | **GET** /api/v1/tasks | 
+*WorkerApi* | [**complete_job**](docs/WorkerApi.md#complete_job) | **POST** /api/v1/jobs/{id}/complete | 
+*WorkerApi* | [**fail_job**](docs/WorkerApi.md#fail_job) | **POST** /api/v1/jobs/{id}/fail | 
+*WorkerApi* | [**heartbeat_job**](docs/WorkerApi.md#heartbeat_job) | **POST** /api/v1/jobs/{id}/heartbeat | 
+*WorkerApi* | [**lease_jobs**](docs/WorkerApi.md#lease_jobs) | **POST** /api/v1/queues/{queue}/lease | 
+*WorkflowsApi* | [**cancel_workflow**](docs/WorkflowsApi.md#cancel_workflow) | **POST** /api/v1/workflows/{id}/cancel | 
+*WorkflowsApi* | [**create_workflow**](docs/WorkflowsApi.md#create_workflow) | **POST** /api/v1/workflows | 
+*WorkflowsApi* | [**get_workflow**](docs/WorkflowsApi.md#get_workflow) | **GET** /api/v1/workflows/{id} | 
+*WorkflowsApi* | [**get_workflow_diagram**](docs/WorkflowsApi.md#get_workflow_diagram) | **GET** /api/v1/workflows/{id}/diagram | 
+*WorkflowsApi* | [**get_workflow_step_states**](docs/WorkflowsApi.md#get_workflow_step_states) | **GET** /api/v1/workflows/{id}/steps | 
+*WorkflowsApi* | [**list_workflows**](docs/WorkflowsApi.md#list_workflows) | **GET** /api/v1/workflows | 
+
+
+## Documentation For Models
+
+ - [BackoffStrategy](docs/BackoffStrategy.md)
+ - [CompleteJobRequest](docs/CompleteJobRequest.md)
+ - [CreateBatchJobsRequest](docs/CreateBatchJobsRequest.md)
+ - [CreateBatchJobsResponse](docs/CreateBatchJobsResponse.md)
+ - [CreateCronRequest](docs/CreateCronRequest.md)
+ - [CreateCronResponse](docs/CreateCronResponse.md)
+ - [CreateJobRequest](docs/CreateJobRequest.md)
+ - [CreateJobResponse](docs/CreateJobResponse.md)
+ - [CreateWorkflowRequest](docs/CreateWorkflowRequest.md)
+ - [CreateWorkflowResponse](docs/CreateWorkflowResponse.md)
+ - [CronSchedule](docs/CronSchedule.md)
+ - [DeadLetter](docs/DeadLetter.md)
+ - [ErrorBody](docs/ErrorBody.md)
+ - [FailJobRequest](docs/FailJobRequest.md)
+ - [HealthStatus](docs/HealthStatus.md)
+ - [HeartbeatRequest](docs/HeartbeatRequest.md)
+ - [HeartbeatResponse](docs/HeartbeatResponse.md)
+ - [Job](docs/Job.md)
+ - [JobConfig](docs/JobConfig.md)
+ - [JobConfigRequest](docs/JobConfigRequest.md)
+ - [JobStatus](docs/JobStatus.md)
+ - [LeaseJobsRequest](docs/LeaseJobsRequest.md)
+ - [LeaseJobsResponse](docs/LeaseJobsResponse.md)
+ - [LeasedJob](docs/LeasedJob.md)
+ - [ListCronsResponse](docs/ListCronsResponse.md)
+ - [ListDeadLettersResponse](docs/ListDeadLettersResponse.md)
+ - [ListJobsResponse](docs/ListJobsResponse.md)
+ - [ListWorkflowsResponse](docs/ListWorkflowsResponse.md)
+ - [OnFailure](docs/OnFailure.md)
+ - [OnSuccess](docs/OnSuccess.md)
+ - [ReadyStatus](docs/ReadyStatus.md)
+ - [ReplayDeadLetterResponse](docs/ReplayDeadLetterResponse.md)
+ - [StatsSnapshot](docs/StatsSnapshot.md)
+ - [StepStatus](docs/StepStatus.md)
+ - [TasksResponse](docs/TasksResponse.md)
+ - [Workflow](docs/Workflow.md)
+ - [WorkflowDiagramResponse](docs/WorkflowDiagramResponse.md)
+ - [WorkflowStatus](docs/WorkflowStatus.md)
+ - [WorkflowStep](docs/WorkflowStep.md)
+ - [WorkflowStepState](docs/WorkflowStepState.md)
+ - [WorkflowStepStatesResponse](docs/WorkflowStepStatesResponse.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="bearerAuth"></a>
+### bearerAuth
+
+- **Type**: Bearer authentication (API Key)
+
+
+## Author
+
+
+
+

queueflow-0.1.0/pyproject.toml

@@ -0,0 +1,89 @@
+[tool.poetry]
+name = "queueflow"
+version = "0.1.0"
+description = "QueueFlow API"
+authors = ["QueueFlow"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/elision-labs/queueflow-sdk-python"
+keywords = ["OpenAPI", "OpenAPI-Generator", "QueueFlow API"]
+include = ["queueflow/py.typed"]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+urllib3 = ">= 1.25.3 < 3.0.0"
+python-dateutil = ">= 2.8.2"
+pydantic = ">= 2"
+typing-extensions = ">= 4.7.1"
+
+[tool.poetry.dev-dependencies]
+pytest = ">= 7.2.1"
+pytest-cov = ">= 2.8.1"
+tox = ">= 3.9.0"
+flake8 = ">= 4.0.0"
+types-python-dateutil = ">= 2.8.19.14"
+mypy = ">= 1.5"
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"
+
+[tool.mypy]
+files = [
+  "queueflow",
+  "test",
+  
+]
+# TODO: enable "strict" once all these individual checks are passing
+# strict = true
+
+# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+## Getting these passing should be easy
+strict_equality = true
+extra_checks = true
+
+## Strongly recommend enabling this one as soon as you can
+check_untyped_defs = true
+
+## These shouldn't be too much additional work, but may be tricky to
+## get passing if you use a lot of untyped libraries
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+
+### These next few are various gradations of forcing use of type annotations
+#disallow_untyped_calls = true
+#disallow_incomplete_defs = true
+#disallow_untyped_defs = true
+#
+### This one isn't too hard to get passing, but return on investment is lower
+#no_implicit_reexport = true
+#
+### This one can be tricky to get passing if you use a lot of untyped libraries
+#warn_return_any = true
+
+[[tool.mypy.overrides]]
+module = [
+  "queueflow.configuration",
+]
+warn_unused_ignores = true
+strict_equality = true
+extra_checks = true
+check_untyped_defs = true
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+disallow_untyped_calls = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_reexport = true
+warn_return_any = true

queueflow-0.1.0/queueflow/__init__.py

@@ -0,0 +1,80 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    QueueFlow API
+
+    REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "0.1.0"
+
+# import apis into sdk package
+from queueflow.api.cron_api import CronApi
+from queueflow.api.dlq_api import DlqApi
+from queueflow.api.health_api import HealthApi
+from queueflow.api.jobs_api import JobsApi
+from queueflow.api.system_api import SystemApi
+from queueflow.api.worker_api import WorkerApi
+from queueflow.api.workflows_api import WorkflowsApi
+
+# import ApiClient
+from queueflow.api_response import ApiResponse
+from queueflow.api_client import ApiClient
+from queueflow.configuration import Configuration
+from queueflow.exceptions import OpenApiException
+from queueflow.exceptions import ApiTypeError
+from queueflow.exceptions import ApiValueError
+from queueflow.exceptions import ApiKeyError
+from queueflow.exceptions import ApiAttributeError
+from queueflow.exceptions import ApiException
+
+# import models into sdk package
+from queueflow.models.backoff_strategy import BackoffStrategy
+from queueflow.models.complete_job_request import CompleteJobRequest
+from queueflow.models.create_batch_jobs_request import CreateBatchJobsRequest
+from queueflow.models.create_batch_jobs_response import CreateBatchJobsResponse
+from queueflow.models.create_cron_request import CreateCronRequest
+from queueflow.models.create_cron_response import CreateCronResponse
+from queueflow.models.create_job_request import CreateJobRequest
+from queueflow.models.create_job_response import CreateJobResponse
+from queueflow.models.create_workflow_request import CreateWorkflowRequest
+from queueflow.models.create_workflow_response import CreateWorkflowResponse
+from queueflow.models.cron_schedule import CronSchedule
+from queueflow.models.dead_letter import DeadLetter
+from queueflow.models.error_body import ErrorBody
+from queueflow.models.fail_job_request import FailJobRequest
+from queueflow.models.health_status import HealthStatus
+from queueflow.models.heartbeat_request import HeartbeatRequest
+from queueflow.models.heartbeat_response import HeartbeatResponse
+from queueflow.models.job import Job
+from queueflow.models.job_config import JobConfig
+from queueflow.models.job_config_request import JobConfigRequest
+from queueflow.models.job_status import JobStatus
+from queueflow.models.lease_jobs_request import LeaseJobsRequest
+from queueflow.models.lease_jobs_response import LeaseJobsResponse
+from queueflow.models.leased_job import LeasedJob
+from queueflow.models.list_crons_response import ListCronsResponse
+from queueflow.models.list_dead_letters_response import ListDeadLettersResponse
+from queueflow.models.list_jobs_response import ListJobsResponse
+from queueflow.models.list_workflows_response import ListWorkflowsResponse
+from queueflow.models.on_failure import OnFailure
+from queueflow.models.on_success import OnSuccess
+from queueflow.models.ready_status import ReadyStatus
+from queueflow.models.replay_dead_letter_response import ReplayDeadLetterResponse
+from queueflow.models.stats_snapshot import StatsSnapshot
+from queueflow.models.step_status import StepStatus
+from queueflow.models.tasks_response import TasksResponse
+from queueflow.models.workflow import Workflow
+from queueflow.models.workflow_diagram_response import WorkflowDiagramResponse
+from queueflow.models.workflow_status import WorkflowStatus
+from queueflow.models.workflow_step import WorkflowStep
+from queueflow.models.workflow_step_state import WorkflowStepState
+from queueflow.models.workflow_step_states_response import WorkflowStepStatesResponse

queueflow-0.1.0/queueflow/api/__init__.py

@@ -0,0 +1,11 @@
+# flake8: noqa
+
+# import apis into api package
+from queueflow.api.cron_api import CronApi
+from queueflow.api.dlq_api import DlqApi
+from queueflow.api.health_api import HealthApi
+from queueflow.api.jobs_api import JobsApi
+from queueflow.api.system_api import SystemApi
+from queueflow.api.worker_api import WorkerApi
+from queueflow.api.workflows_api import WorkflowsApi
+