Metadata-Version: 2.1
Name: octoxlabs
Version: 0.2.2
Summary: py-octoxlabs is an API client for Octox Labs Cyber Security Asset Management platform on python programming language.
Author-email: Octox Labs Development Team <development@octoxlabs.com>
License: MIT License
        
        Copyright (c) 2022 Octox Labs 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/octoxlabs/py-octoxlabs
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Octox Labs Python SDK
py-octoxlabs is an API client for Octox Labs Cyber Security Asset Management platform on python programming language.

## Installation
```shell
pip install octoxlabs
```

## Getting Started
1. Go to settings
2. Click "Add User" button
3. Type Username and choose User Type as "API User"
4. Click "Create" button
5. Click your user's Edit button
6. Copy API Token

## Quick Start

```python
from octoxlabs import OctoxLabs

octo = OctoxLabs(ip="<your-octoxlabs-platform-ip>", token="<your-api-token>")
count, assets = octo.search_devices(query="Adapters = active-directory")
```

## Contributing
Also see; [CONTRIBUTING.md](CONTRIBUTING.md)
