Metadata-Version: 2.1
Name: freqsignals-client
Version: 0.0.1
Summary: FreqSignals Client for Python
Home-page: https://github.com/freqsignals/freqsignals-client
Author: Matt Ferrante
Author-email: matt@freqsignals.com
License: MIT
Description: # freqsignals-client
        
        [FreqSignals](https://freqsignals.com) client for python! It assists in token management and abstracts the HTTP requests to make it easy to upload or download signals.
        
        ## Docs
        
        ### FreqSignalsClient
        
        #### init
        ```python
        from freqsignals_client import FreqSignalsClient,
        client = FreqSignalsClient(
            client_id="1234",
            client_secret="567890",
        )
        ```
        
        #### get_signals
        [see documentation](https://freqsignals.com/documentation#oauth2-api-token-integration)
        
        ```python
        client.get_signals()
        ```
        
        _Note_: Might raise a `freqsignals_client.FreqSignalsError` if FreqSignals rejects the request
        
        _Note_: Might raise a `freqsignals_client.FreqSignalsTimeoutError` if the request times out
        
        #### post_signal
        [see documentation](https://freqsignals.com/documentation#oauth2-api-token-integration)
        
        ```python
        client.post_signal({
            "symbol": "BTC",
            "value": 0.1,
            "ttl_minutes": 60,
            "data_set_id": "DATA_SET_ID"
        })
        ```
        
        #### logging
        To get visibility into logged events, override the log method and log however your app needs to log:
        ```python
        class CustomFreqSignalsClass(FreqSignalsClient):
            def log(self, level, msg, **log_variables):
                print(f"[{level}] {msg}", log_variables)
                
        
        client = CustomFreqSignalsClass(client_id, client_secret)
        ```
        
        ## Example
        ```python
        from freqsignals import FreqSignalsClient, FreqSignalsError, FreqSignalsTimeoutError
        
        my_client = FreqSignalsClient("1234", "56-789")
        try:
            results = my_client.get_signals()
            print(results)
        except FreqSignalsError:
            print("FreqSignals failure")
        except FreqSignalsTimeoutError:
            print("FreqSignals timed out")
        ```
        
        ## Common Commands:
        
        Black Formatting
        ```bash
        $ black freqsignals_client --config freqsignals_client.toml
        ```
        
        Build
        ```bash
        $ python3 setup.py sdist
        ```
        
        Pypi Distribution
        ```bash
        $ python3 -m twine upload dist/*
        ```
        
        ## License
        
        FreqSignals Client is [MIT licensed](./LICENSE).
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
