From db9165932d1813542d3d416b458dcd21a398cb96 Mon Sep 17 00:00:00 2001 From: Armin Ronacher Date: Fri, 28 Feb 2020 12:34:49 +0100 Subject: [PATCH] ref: update readme --- README.md | 3 +++ coredump_uploader/__init__.py | 6 +++++- pyproject.toml | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 787cf9a..77667f6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Coredump Uploader +This utility can upload core dumps to Sentry. It can either upload a single core dump or watch a folder +for incoming core dumps to automatically upload them as they happen. + ## Requirements - python diff --git a/coredump_uploader/__init__.py b/coredump_uploader/__init__.py index 6a795a9..de9f638 100644 --- a/coredump_uploader/__init__.py +++ b/coredump_uploader/__init__.py @@ -601,7 +601,11 @@ class CoredumpUploader(object): ) @click.pass_context def cli(context, path_to_executable, sentry_dsn, gdb_path, elfutils_path, all_threads): - """Initialize Sentry-dsn and Coredump-uploader""" + """Sentry coredump uploader + + This utility can upload core dumps to sentry by stack walking them with the help + of GDB. + """ sentry_sdk.init(sentry_dsn, max_breadcrumbs=0) uploader = CoredumpUploader( path_to_executable, sentry_dsn, gdb_path, elfutils_path, all_threads diff --git a/pyproject.toml b/pyproject.toml index b1ae6e1..e2c39f8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ description = "" authors = ["Dominik Rindhauser "] [tool.poetry.dependencies] -python = "^2.7" +python = "^2.7 || ^3.5" sentry-sdk = "^0.14.1" click = "^7.0" watchdog = "^0.8.2" @@ -14,7 +14,7 @@ watchdog = "^0.8.2" pytest = "^4.6.9" [tool.poetry.scripts] -upload_coredump = "coredump_uploader:main" +upload_coredump = "coredump_uploader:cli" [build-system] requires = ["poetry>=0.12"]