Metadata-Version: 2.1
Name: uptycs-py
Version: 0.0.3
Summary: Uptycs API helper library (for Python 3)
Home-page: https://github.com/Uptycs/uptycs-py
Author: Julian Wayte
Author-email: Julian Wayte <jwayte@uptycs.com>, Serge Teren <steren@uptycs.com>
Maintainer-email: Chandrasekhar <cgadde@uptycs.com>, Alan Koshy <akoshy@uptycs.com>
License: MIT License
        
        Copyright (c) 2023 Uptycs Inc
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/pypa/uptycs_py
Project-URL: Bug Tracker, https://github.com/pypa/uptycs-py/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# uptycs_py
Uptycs API helper library (for Python 3)

## Installation

If you already know how to install python packages, then you can install it via pip:

You might need sudo on linux. if you want to install using pip, you can use following command:
```
$ sudo pip install uptycs-py
```

## Usage

This modules contains classes to interact with the Uptycs API using Python.
```
Some commonly used classes include:
  UptApiAuth()     - Read an Uptycs API key file and create authorization header
  UptApiCall()     - Call an Uptycs API method
  UptAlertRule()   - Get or Create an alert rule
  UptAssets()      - Show/update assets registered in Uptycs, add/remove tags from assets
  UptEventRule()   - Get or Create an event rule
  UptLkpTable()    - Get or Create a lookup table (typically for whitelists/blacklists)
  UptQueryGlobal() - Run a query against global (flight recorder)
  UptQueryRt()     - Run a query against realtime
```

Test sample:

```
import sys
import uptycs_py

keyfile = sys.argv[1]
myauth = uptycs_py.UptApiAuth(keyfile)
myasset = uptycs_py.UptAssets(myauth)
print("Total number of assets %s " % len(myasset.items))
print(myasset.get_id_from_hostname('test_host_name'))
```
