Metadata-Version: 2.1
Name: shorthandai
Version: 0.0.4
Summary: Python utilities for interacting with ShorthandAI data
Home-page: UNKNOWN
Author: Habanero Research LLC
License: UNKNOWN
Description: ## shorthandai
        
        This package provides a Python SDK for working with the ShorthandAI platform.
        
        ### Installation
        ```sh
        $ pip install shorthandai
        ```
        
        ### Usage
        ```py
        from shorthandai import ShorthandAI
        
        # Token can be passed by setting the environment variable `SHORTHANDAI_TOKEN`.
        # token can be generated at https://apiv1.shorthand.ai/console/tokens
        SH = ShorthandAI()
        
        # Alternately, pass in the token explicitly
        token = 'sh-...' 
        SH = ShorthandAI(token)
        
        # Get values
        print(SH.get("dev123"))
        
        # Set values
        print(SH.set("dev123", 4000))
        
        import datetime
        # Get historical
        print(SH.geth("dev123", datetime.datetime(2022, 12, 31)))
        ```
        
        For example, new users can try out the following:
        ```py
        from shorthandai import ShorthandAI
        
        SH = ShorthandAI('demo')
        print(SH.info())
        print(SH.GET('dev123', '1659994710026'))
        print(SH.GET('dev123', 'notexists'))
        print(SH.GET('dev123'))
        print(SH.GET('dev444'))
        
        print("\nTesting GET-historical\n")
        import datetime
        print(SH.GETH('dev123', datetime.datetime(2022, 12, 31)))
        print(SH.GETH('dev123', datetime.datetime(2022, 11, 1)))
        print(SH.GETH('dev123', datetime.datetime(2023, 2, 24)))
        
        print("\nTesting SET\n")
        print(SH.SET('dev555-scalar', 1000))
        print(SH.GET('dev555-scalar'))
        
        new_df = pd.DataFrame({
            'Name': ['Tom', 'nick', 'krish', 'jack'],
            'Age': [20, 21, 19, 18]
        })
        print(new_df)
        print(SH.SET('dev777-pd', new_df))
        print(SH.GET('dev777-pd'))
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
