https://github.com/gophish/api-client-python

A Python API Client for Gophish
https://github.com/gophish/api-client-python

api gophish python

Last synced: 3 days ago
JSON representation

A Python API Client for Gophish

• Host: GitHub
• URL: https://github.com/gophish/api-client-python
• Owner: gophish
• License: mit
• Created: 2017-01-16T23:34:09.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-01-11T14:17:04.000Z (about 1 year ago)
• Last Synced: 2025-02-08T11:51:17.911Z (13 days ago)
• Topics: api, gophish, python
• Language: Python
• Size: 43.9 KB
• Stars: 47
• Watchers: 8
• Forks: 48
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gophish Python API Client

Gophish was built from the ground-up to be API-first. This means that we build out the API endpoints for all of our features, and the UI is simply a wrapper around these endpoints.

To interface with Gophish using Python, we've created a `gophish` client library.

> If you want to access the API directly, please refer to our [API Documentation](https://www.gitbook.com/book/gophish/api-documentation/details)

## Installation

To install the `gophish` library, simply run the command:

`pip install gophish`

## Quickstart

Getting up and running with the Python library is quick and easy.

To start, simply create a client using the API key found in the [Settings page](https://gophish.gitbooks.io/user-guide/content/documentation/changing_user_settings.html#changing-your-password--updating-settings).

```python

from gophish import Gophish

api_key = 'API_KEY'

api = Gophish(api_key)

```

Now you're ready to start using the API!

## Full Documentation

You can find the full Python client documentation [here.](https://docs.getgophish.com/python-api-client/)