Etelemetry-client
A lightweight python client to communicate with the etelemetry server
Installation
pip install etelemetry
Usage
import etelemetry
etelemetry.get_project("nipy/nipype")
{'version': '1.4.2', 'bad_versions': ['1.2.1', '1.2.3', '1.3.0']}
or to take advantage of comparing and checking for bad versions, you can use the following form
import etelemetry
etelemetry.check_available_version("nipy/nipype", "1.2.1") # github_org/project
A newer version (1.4.2) of nipy/nipype is available. You are using 1.2.1
You are using a version of nipy/nipype with a critical bug. Please use a different version.
returns: {'version': '1.4.2', 'bad_versions': ['1.2.1', '1.2.3', '1.3.0']}
Adding etelemetry to your project
You can include etelemetry in your project by adding etelemetry package to your setup process
and by adding the following snippet to your __init__.py. The code snippet below assumes you
have a __version__ and usemylogger (logger) variables available. The check takes the form
of github_org/project.
# Run telemetry on import for interactive sessions, such as IPython, Jupyter
# notebooks, Python REPL
import __main__
if not hasattr(__main__, "__file__"):
import etelemetry
etelemetry.check_available_version("dandi/dandi-cli", __version__, lgr=usemylogger)
To add support checking for bad versions you will need to add a file named
.et to your github project containing a simple json snippet.
{ "bad_versions" : []
}
Here is an example: https://github.com/nipy/nipype/blob/master/.et
Metadata
Release files for etelemetry 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| etelemetry-0.3.1-py3-none-any.whl | Python 3 | none | any | Details for etelemetry-0.3.1-py3-none-any.whl |
Release files / etelemetry-0.3.1-py3-none-any.whl
| Download URL | etelemetry-0.3.1-py3-none-any.whl |
|---|---|
| Size | 6.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a64f09bcd55cbfa5684e4d9fb6d1d6a018ab99d2ea28e638435c4c26e6814a6b
|
|
BLAKE2b-256 checksum How to use checksums |
8327f997c9da0e179986fadd6c8474d16743f1b3697c129c2fcd1e739cd038c2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.5
|
Security for etelemetry 0.3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.