rearrage package structure

Author: ns-axu

.gitignore

@@ -1,3 +1,9 @@
+.DS_Store
+.venv*
+.vscode
+**/*.pyc
+**/dist
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

LICENSE.md

@@ -0,0 +1,21 @@
+Copyright (c) 2020, Narrative Science
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+- Neither the name of the <organization> nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,139 +1,42 @@
-# openapi-client
-https://www.stitchdata.com/docs/developers/stitch-connect/api
+# stitch-connect-client 
 
-This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+[![](https://img.shields.io/pypi/v/stitch-connect-client.svg)](https://pypi.org/pypi/stitch-connect-client/) [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 
-- API version: 0.1
-- Package version: 1.0.0
-- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+<!-- Short description of the package -->
 
-## Requirements.
+Features:
 
-Python 2.7 and 3.4+
+- <!-- list of features -->
 
-## Installation & Usage
-### pip install
+Table of Contents:
 
-If the python package is hosted on a repository, you can install directly using:
+- [Installation](#installation)
+- [Guide](#guide)
+- [Development](#development)
 
-```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 openapi_client 
-```
+## Installation
 
-### 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)
+stitch-connect-client requires Python 3.6 or above.
 
-Then import the package:
-```python
-import openapi_client
+```bash
+pip install stitch-connect-client
 ```
 
-## Getting Started
+## Guide
 
-Please follow the [installation procedure](#installation--usage) and then run the following:
+<!-- Subsections explaining how to use the package -->
 
-```python
-from __future__ import print_function
-import time
-import openapi_client
-from openapi_client.rest import ApiException
-from pprint import pprint
+## Development
 
-configuration = openapi_client.Configuration()
-# Configure Bearer authorization: bearerAuth
-configuration.access_token = 'YOUR_BEARER_TOKEN'
-
-# Defining host is optional and default to https://stitchdata.com
-configuration.host = "https://stitchdata.com"
-# Create an instance of the API class
-api_instance = openapi_client.DestinationsApi(openapi_client.ApiClient(configuration))
-destination_info = openapi_client.DestinationInfo() # DestinationInfo | Object containing type and properties of a destination (optional)
-
-try:
-    # Creates a new destination. Only a single destination is supported per Stitch client account. 
-    api_instance.create_destination(destination_info=destination_info)
-except ApiException as e:
-    print("Exception when calling DestinationsApi->create_destination: %s\n" % e)
+To develop stitch-connect-client, install dependencies and enable the pre-commit hook:
 
+```bash
+pip install pre-commit tox
+pre-commit install
 ```
 
-## Documentation for API Endpoints
-
-All URIs are relative to *https://stitchdata.com*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*DestinationsApi* | [**create_destination**](docs/DestinationsApi.md#create_destination) | **POST** /v4/destinations | Creates a new destination. Only a single destination is supported per Stitch client account. 
-*DestinationsApi* | [**delete_destination**](docs/DestinationsApi.md#delete_destination) | **DELETE** /v4/destinations/{destination_id} | Deletes an existing destination. Note: Stitch requires a destination to replicate data. Replication will be paused until a new destination is created and has a successful connection. 
-*DestinationsApi* | [**get_destination_types**](docs/DestinationsApi.md#get_destination_types) | **GET** /v4/destination-types | Retrieves general information about the configuration required for all supported destination types. 
-*DestinationsApi* | [**get_destinations**](docs/DestinationsApi.md#get_destinations) | **GET** /v4/destinations | Lists the destination currently in use for a Stitch account. Only a single data warehouse is supported per Stitch client account. 
-*DestinationsApi* | [**update_destination**](docs/DestinationsApi.md#update_destination) | **PUT** /v4/destinations/{destination_id} | Updates an existing destination. Modifications to the type attribute are not supported. 
-*SourcesApi* | [**create_source**](docs/SourcesApi.md#create_source) | **POST** /v4/sources | Creates a source object, which is the first step in setting up a new data source. After the source object is created, additional configuration steps must be completed. 
-*SourcesApi* | [**delete_source**](docs/SourcesApi.md#delete_source) | **DELETE** /v4/sources/{source_id} | Deletes an existing data source.
-*SourcesApi* | [**get_last_connection_check**](docs/SourcesApi.md#get_last_connection_check) | **GET** /v4/sources/{source_id}/last-connection-check | Retrieves the last connection check for a source by the source’s unique identifier. 
-*SourcesApi* | [**get_source**](docs/SourcesApi.md#get_source) | **GET** /v4/sources/{source_id} | Retrieves a previously created data source by its unique identifier. This endpoint can be used to retrieve an active, paused, or deleted source. 
-*SourcesApi* | [**get_sources**](docs/SourcesApi.md#get_sources) | **GET** /v4/sources | Lists the sources for an account, including active, paused, and deleted sources. 
-*SourcesApi* | [**start_replication**](docs/SourcesApi.md#start_replication) | **POST** /v4/sources/{source_id}/sync | Manually starts a replication job for a source using the source’s unique identifier. 
-*SourcesApi* | [**update_source**](docs/SourcesApi.md#update_source) | **PUT** /v4/sources/{source_id} | Updates an existing data source.
-*StreamsApi* | [**get_stream_schema**](docs/StreamsApi.md#get_stream_schema) | **GET** /v4/sources/{source_id}/streams/{stream_id} | Retrieves the schema for a source’s stream by the source and stream’s unique identifiers. 
-*StreamsApi* | [**get_streams**](docs/StreamsApi.md#get_streams) | **GET** /v4/sources/{source_id}/streams | Lists the available streams for a source.
-*StreamsApi* | [**update_stream_metadata**](docs/StreamsApi.md#update_stream_metadata) | **PUT** /v4/sources/{source_id}/streams/metadata | Updates the metadata for streams and fields. This endpoint is used to define the metadata properties returned in the Stream Schema object’s non-discoverable-metadata-keys property. 
-
-
-## Documentation For Models
-
- - [AzureDestinationFormProperties](docs/AzureDestinationFormProperties.md)
- - [ConnectionCheck](docs/ConnectionCheck.md)
- - [ConnectionDetails](docs/ConnectionDetails.md)
- - [ConnectionStep](docs/ConnectionStep.md)
- - [ConnectionStepProps](docs/ConnectionStepProps.md)
- - [ConnectionStepPropsAnyOf](docs/ConnectionStepPropsAnyOf.md)
- - [ConnectionStepPropsJsonSchema](docs/ConnectionStepPropsJsonSchema.md)
- - [CreateSourceBody](docs/CreateSourceBody.md)
- - [Destination](docs/Destination.md)
- - [DestinationFormProperties](docs/DestinationFormProperties.md)
- - [DestinationInfo](docs/DestinationInfo.md)
- - [DestinationReportCard](docs/DestinationReportCard.md)
- - [ErrorObject](docs/ErrorObject.md)
- - [ErrorObjectError](docs/ErrorObjectError.md)
- - [FieldLevelMetadata](docs/FieldLevelMetadata.md)
- - [HookNotification](docs/HookNotification.md)
- - [HookNotificationConfig](docs/HookNotificationConfig.md)
- - [Metadata](docs/Metadata.md)
- - [ReplicationJob](docs/ReplicationJob.md)
- - [S3DestinationFormProperties](docs/S3DestinationFormProperties.md)
- - [SalesforceSourceFormProperties](docs/SalesforceSourceFormProperties.md)
- - [Source](docs/Source.md)
- - [SourceFormProperties](docs/SourceFormProperties.md)
- - [SourceReportCard](docs/SourceReportCard.md)
- - [Stream](docs/Stream.md)
- - [StreamLevelMetadata](docs/StreamLevelMetadata.md)
- - [StreamSchema](docs/StreamSchema.md)
- - [UpdateSourceBody](docs/UpdateSourceBody.md)
-
-
-## Documentation For Authorization
-
-
-## bearerAuth
-
-- **Type**: Bearer authentication
-
-
-## Author
-
-
-
+To run tests:
 
+```bash
+tox
+```