Metadata-Version: 2.1
Name: hyperscience-saas-client
Version: 1.0.5
Summary: hyperscience saas client library
Home-page: UNKNOWN
Author: Hyperscience
License: Apache License 2.0
Description: # Hyperscience SaaS Client Library
        The Hyperscience SaaS Client Library allows SaaS users to authenticate and use the API programmatically and seamlessly.
        
        ## Installation
        
        You can install the Hyperscience SAAS Client Library from [PyPI](https://pypi.org/project/hyperscience-saas-client/):
        
            pip install hyperscience-saas-client
        
        ## How to use
        The Hyperscience client library can be used in code:
        ```python
        from hyperscience import ApiController, CredentialsProvider, Configuration
        
        credentials = CredentialsProvider('client_id', 'client_secret')            
        configuration = Configuration('cloud.hyperscience.net')
        api_controller = ApiController(configuration, credentials)
        
        response = api_controller.get('/api/v5/healthcheck')
        ```
        
        # Releasing a new version
        
        Releasing a new version includes:
        - Creating a new Git tag.
        - Publishing to PYPI.
        
        To trigger a release:
        - Update file `package-version.txt` to set the right version. Follow
          [Package Versioning](https://semver.org/)
          guidelines to set the right version number. 
        - Update `CHANGELOG.md` file to
          reflect the latest changes.
        - Create a new merge request.
        - Once merged, a pipeline will trigger. Run `deploy-job` manually inside that
          pipeline.
Platform: UNKNOWN
Description-Content-Type: text/markdown
