Metadata-Version: 2.1
Name: monetdb-pystethoscope
Version: 0.1.1
Summary: MonetDB profiler connection tool
Home-page: https://github.com/MonetDBSolutions/monetdb-pystethoscope
Author: Panagiotis Koutsourakis
Author-email: kutsurak@monetdbsolutions.com
Requires-Python: >=3.6,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: click (>=7.0,<8.0)
Requires-Dist: pymonetdb (>=1.3.1,<2.0.0)
Project-URL: Repository, https://github.com/MonetDBSolutions/monetdb-pystethoscope
Description-Content-Type: text/x-rst

|ActionsBadge|_ |DocsBadge|_

Introduction
============

``pystethoscope`` is a command line tool to filter and format the events coming
from the MonetDB profiler. The profiler is part of the MonetDB server and works
by emitting two JSON objects: one at the start and one at the end of every MAL
instruction executed. ``pystethoscope`` connects to a MonetDB server process,
reads the objects emitted by the profiler and performs various transformations
specified by the user.

Installation
============

Installation is done via pip:

.. code:: shell

   pip install monetdb-pystethoscope

This project is compatible with Python 3.6 or later and with MonetDB server
version Jun2020 or later.

We recommend the use of virtual environments (see `this
primer <https://realpython.com/python-virtual-environments-a-primer/>`__
if you are unfamiliar) for installing and using
``monetdb-pystethoscope``.

Developer notes
===============

``pystethoscope`` is developed using
`Poetry <https://python-poetry.org/>`__, for dependency management and
packaging.

Installation for development
----------------------------

In order to install ``pystethoscope`` do the following:

.. code:: shell

   pip3 install --user poetry
   PYTHON_BIN_PATH="$(python3 -m site --user-base)/bin"
   export PATH="$PATH:$PYTHON_BIN_PATH"

   git clone git@github.com:MonetDBSolutions/monetdb-pystethoscope.git
   cd monetdb-pystethoscope
   poetry install
   poetry run pystethoscope --help

Documentation
=============

For more detailed documentation please see the documentation on `readthedocs
<https://monetdb-pystethoscope.readthedocs.io/en/latest/>`__.

.. |ActionsBadge| image:: https://github.com/MonetDBSolutions/monetdb-pystethoscope/workflows/Test%20pystethoscope/badge.svg?branch=master
.. _ActionsBadge: https://github.com/MonetDBSolutions/monetdb-pystethoscope/actions
.. |DocsBadge| image:: https://readthedocs.org/projects/monetdb-pystethoscope/badge/?version=latest
.. _DocsBadge: https://monetdb-pystethoscope.readthedocs.io/en/latest/?badge=latest

