florgon / gatey-sdk-py

Gatey Python SDK. Works with Florgon hosted, or self-hosted server.

Florgon Gatey SDK for Python (Official).

This is the official Python SDK for Florgon Gatey

Getting Started

Install

pip install --upgrade gatey-sdk

Configuration

import gatey_sdk
client = gatey_sdk.Client(
    project_id=PROJECT_ID,
    server_secret=PROJECT_SERVER_SECRET,
    client_secret=PROJECT_CLIENT_SECRET,
)
# Notice that you should only enter server or client secret, passing both have no effect as always server will be used.
# (as client not preferred if server secret is passed).

Usage

import gatey_sdk
client = gatey_sdk.Client(
    project_id=PROJECT_ID,
    server_secret=PROJECT_SERVER_SECRET,
)

# Will send message (capture).
client.capture_message("Hello Python Gatey SDK!", level="DEBUG")

# Will capture exception.
@client.catch()
def f():
    raise ValueError

# Same as above.
try:
    raise ValueError
except Exception as e:
    client.capture_exception(e)

# Will work by default also (see Client(handle_global_exceptions=True))
raise ValueError


# (Notice that events by default being sent not immediatly!)

Examples

See examples directory...

Integrations

See integrations directory...
See examples directory...

• Starlette (FastAPI) integration
• Flask integration
• Django integration

Documentation.

ReadTheDocs
Gatey Documentation

License

Licensed under the MIT license, see LICENSE

gatey-sdk-py's Issues

API domain was changed. Migrate to new domain.

Before it was: https://api.florgon.space/gatey/v1.
Now it is: https://api-gatey.florgon.space/v1

Allow to send custom tags / fields.

For now there is not that feature in the API.

Allow to disable global internal handler on internal exception caused in wrapped handler.

Fix `mypy` warns.

Get context lines (+-5 lines) of the last traceback file.

Fix `pypi` description and other metadata.

Add sessions system for the client.

Add tests (`pytest` or whatever) with CI.

Cache platform/runtime information after first query request.

Migrate to native `urllib` or something similar.

CPU Model name is weird.

Hi. In https://github.com/florgon/gatey-sdk-py/edit/main/gatey_sdk/platform.py CPU information is alright, but it's not understandable at first.

The issue here, when the regular user sees

Intel64 Family 6 Model 23 Stepping 6, GenuineIntel

instead of

Intel Celeron(R) Dual-Core CPU T3300 2.00GHz

it confuses the user. What the hell is Intel64 Family 6 Model 23? Where is my Intel Celeron Dual-Core T3300?

I have a solution for this, use cpuinfo library instead of platform.

And instead of codenames, the user will see the brand name of the CPU, that won't confuse the user.

Example: cpuinfo.cpu.info[0]['model name']
I've already created a commit, can you merge my changes to the main repo?

Greetings,
Emil