Metadata-Version: 2.1
Name: migas
Version: 0.0.3
Summary: Migas Python client
License: Apache License, 2.0
Project-URL: Source Code, https://github.com/mgxd/migas-py
Project-URL: Bug Tracker, https://github.com/mgxd/migas-py/issues
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Provides: migas
Requires-Python: >=3.7
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Provides-Extra: dev
Provides-Extra: test
License-File: LICENSE

# Migas Client

A Python package to communicate with a migas server.

## API

`migas` includes the following functions to communicate with the telemetry server:

### migas.add_project()

Send a breadcrumb with usage information to the server.
The server will attempt to return information about the project,
such as the latest version and bad versions.

### migas.get_usage()

Check number of uses a `project` has received from a start date, and optionally an end date.
If no end date is specified, the current datetime is used.

## Customization

Normally, calling `migas.setup()` will populate the internal configuration with the default endpoint,
but in cases where you wish to host your own instance of a `migas` server,
you can pass in an `endpoint` parameter to route traffic accordingly.
