Metadata-Version: 2.1
Name: bearer
Version: 2.0.0
Summary: Bearer python helper
Home-page: https://github.com/Bearer/bearer-python
Author: Bearer Team
Author-email: engineering+python@bearer.sh
License: UNKNOWN
Description: # Bearer Python
        
        Bearer Python client
        
        ## Installation
        
        ```
        pip install bearer
        ```
        
        ## Usage
        
        Get your Bearer [Secret Key](https://app.bearer.sh/keys) and integration id from
        the [Dashboard](https://app.bearer.sh) and use the Bearer client as follows:
        
        ### Calling any APIs
        
        ```python
        from bearer import Bearer
        
        bearer = Bearer('BEARER_SECRET_KEY') # find it on https://app.bearer.sh/keys
        github = (
            bearer
              .integration('your integration id') # you'll find it on the Bearer dashboard https://app.bearer.sh
              .auth('your auth id') # Create an auth id for your integration via the dashboard
        )
        
        print(github.get('/repositories').json())
        ```
        
        We use [requests](https://2.python-requests.org/en/master/) internally and we
        return the response from this library from the request methods (`request`,
        `get`, `head`, `post`, `put`, `patch`, `delete`).
        
        More advanced examples:
        
        ```python
        # With query parameters
        print(github.get('/repositories', query={ 'since': 364 }).json())
        
        # With body data
        print(github.post('/user/repos', body={ 'name': 'Just setting up my Bearer.sh' }).json())
        ```
        
        ### Setting the request timeout, and other http client settings
        Bearer client is written on top of excellent [requests](https://github.com/psf/requests "requests library on github") library. Bearer provides reasonable defaults but you can adjust http client configuration by using any keyword argument which is accepted by requests.request method using `http_client_settings` keyword argument.
        By default bearer client times out after 5 seconds. Bearer allows to increase the timeout to up to 30 seconds
        
        ```python
        from bearer import Bearer
        
        bearer = Bearer('BEARER_SECRET_KEY', http_client_settings={"timeout": 10}) # increase the request timeout to 10 seconds globally
        
        # you can specify client settings per integration as well
        github = bearer.integration('github', http_client_settings={"timeout": 2}) # github api is super fast 2 seconds should be plenty
        
        print(github.get('/user/repos'))
        ```
        ## Development
        
        ``` bash
        # setup venv
        $ python -m venv venv
        
        # install dependencies
        $ venv/bin/python setup.py develop
        
        # start the console
        $ venv/bin/python
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
