Metadata-Version: 2.1
Name: houston-client
Version: 1.4.dev1
Summary: Houston Python Client
Author-email: James Watkinson <info@datasparq.ai>, Matt Simmons <info@datasparq.ai>
License: MIT License
        
        Copyright (c) 2020, 2021, 2022, 2023 Datasparq
        
        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.
        
Project-URL: Homepage, https://callhouston.io
Project-URL: Documentation, https://github.com/datasparq-ai/houston/blob/main/docs
Project-URL: Source, https://github.com/datasparq-intelligent-products/houston-python
Keywords: houston
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests<3.0.0dev,>=2.18.0
Requires-Dist: requests[security]<3.0.0dev,>=2.18.0
Requires-Dist: PyYAML
Requires-Dist: retry<1,>=0.9.2
Provides-Extra: gcp
Requires-Dist: google-cloud-secret-manager>=2.5; extra == "gcp"
Requires-Dist: google-cloud-pubsub>=1.2; extra == "gcp"
Requires-Dist: google-cloud-storage>=1.35; extra == "gcp"
Requires-Dist: google-cloud-logging>=2; extra == "gcp"
Provides-Extra: azure
Requires-Dist: azure-eventgrid>=1.2.0; extra == "azure"
Requires-Dist: azure-mgmt-eventgrid>=2.2.0; extra == "azure"

# Houston

![PyPI](https://img.shields.io/pypi/v/houston-client)

Python Client for [Houston](https://callhouston.io), an open source tool for building low cost, scalable, platform-agnostic data pipelines. 
Teams can share data processes as microservices using a simple API.

Documentation: [github.com/datasparq-ai/houston/docs](https://github.com/datasparq-ai/houston/blob/main/docs)

## Installation

This client can be installed via pip:

```bash
pip install houston-client
```

If you're running Houston on Google Cloud Platform you will need the 'gcp' plugin:

```bash
pip install "houston-client[gcp]"
```

## Usage

To get started in under 15 minutes, see the quickstart repo: https://github.com/datasparq-intelligent-products/houston-quickstart-python 

This client has the following uses:
- Saving, updating, and deleting plans: see [save command](https://github.com/datasparq-ai/houston/blob/main/docs/commands.md#save), [delete command](https://github.com/datasparq-ai/houston/blob/main/docs/commands.md#delete)
- Starting missions: see [start command](https://github.com/datasparq-ai/houston/blob/main/docs/commands.md#start)
- Creating Houston microservices:
  - With Google Cloud Functions, see [Cloud Function Service Decorator](houston/gcp/cloud_function.py), [Google Cloud](https://github.com/datasparq-ai/houston/blob/main/docs/google_cloud.md), and [Python Quickstart GCP](https://github.com/datasparq-intelligent-products/houston-quickstart-python/tree/master/google-cloud)
  - With any service: see https://github.com/datasparq-ai/houston/blob/main/docs/services.md, and [service.py](houston/service.py)

Full documentation is available at [github.com/datasparq-ai/houston](https://github.com/datasparq-ai/houston/tree/main/docs)


## Requirements

- Python >= 3.7
