https://github.com/jerodg/53.phishlabs-api-client
Phishlabs Case Data API Client
https://github.com/jerodg/53.phishlabs-api-client
api client phishlabs python rest
Last synced: over 1 year ago
JSON representation
Phishlabs Case Data API Client
- Host: GitHub
- URL: https://github.com/jerodg/53.phishlabs-api-client
- Owner: jerodg
- License: other
- Created: 2019-10-16T18:53:12.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-29T19:10:07.000Z (over 6 years ago)
- Last Synced: 2024-11-10T12:09:18.013Z (over 1 year ago)
- Topics: api, client, phishlabs, python, rest
- Language: Python
- Homepage:
- Size: 705 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
```
```





Phishlabs API Client
## Installation
```bash
pip install phishlabs-api-client
```
## Basic Usage
Works with Phishlabs API
*See examples folder for more*
### Class Inheritence
```python
from phishlabs_api_client import PhishlabsApiClient
class MyClass(PhishlabsApiClient):
def __init__(self):
PhishlabsApiClient.__init__(self, cfg='/path/to/config.toml')
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
PhishlabsApiClient.__aexit__(self, exc_type, exc_val, exc_tb)
```
### Context Manager
```python
from phishlabs_api_client import PhishlabsApiClient
async with PhishlabsApiClient(cfg='/path/to/config.toml') as bac:
alerts = bac.get_alerts()
```
## Documentation
[GitHub Pages](https://jerodg.github.io/phishlabs-api-client/)
- Work in Process
## API Implementation, Categories (0/2) ~0%, Functions (0/6) ~0%
- [ ] Cases
- [ ] Get All Cases
- [ ] Get All Cases Filtered
- [ ] Get One Case
- [ ] Get All Cases Count
- [ ] Get All Cases Count Filtered
- [ ] Attachments
- [ ] Get One Cases Attachments
## License
Copyright © 2019 Jerod Gawne
This program is free software: you can redistribute it and/or modify
it under the terms of the Server Side Public License (SSPL) as
published by MongoDB, Inc., either version 1 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
SSPL for more details.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
You should have received a copy of the SSPL along with this program.
If not, see .