Skip to content

everylogsaas/everylog_python_client

Repository files navigation

everylog_python_client

EveryLog provides a simple way to receive notifications for important application events that you choose.

Installation

The distribution is hosted on pypi at: '#'. To directly install the package from pypi, run from your terminal::

$ pip install everylog_python_client

Usage

Setup

This is to be set once globally (instantiated) from within the project, and used everywhere else

from everylog.everylog_python_client import EveryLogPythonClient

client = EverylogPythonClient()
client.setup(api_key='<YOUR_API_KEY>', projectId='<YOUR_PROJECT_NAME>')



# Notifying the logs whenever you choose to.

### Uses the instantiated object from the class and notify by setting different options.

# @param [Dictionary] log_entry_options
# @option log_entry_options [String, options[:projectId]]  :projectId name of the project
# @option log_entry_options [String]  :title to display in the application and if enabled in the notification
# @option log_entry_options [String]  :summary is a not so long text to display on the application and if enabled in the notification
# @option log_entry_options [String]  :body it can contain a long text simple formatted, no html to display in the application
# @option log_entry_options [Array]   :tags it can be used to categorize the notification, must be strings
# @option log_entry_options [String]  :link it can be used to display on the application and if enabled in the notification
# @option log_entry_options [Boolean] :push if True, a push notification is sent to application
# @option log_entry_options [String]  :icon
# @option log_entry_options [Array]   :externaChannels
# @option log_entry_options [Array[Dictionary]] :properties
# @option log_entry_options [Array]   :groups

client.create_log_entry(title='<Sample Title>')

License

The package is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the EveryLog python client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages