[dev] minor refactorings, and add project description

Author: d-leroy

README.md

@@ -1,4 +1,4 @@
-# monilogger
+# Monilogger
 
 A Python logging and monitoring toolbox for C++ and Python-embedding applications.
 

build-and-test.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+rm dist/*
+python3 -m build
+pip install dist/monilogger-0.0.3.tar.gz
+python3 -m unittest

setup.py

@@ -9,7 +9,7 @@
 from setuptools import Extension, find_packages, setup
 from distutils import ccompiler
 
-__version__ = "0.0.2"
+__version__ = "0.0.3"
 
 # Convert distutils Windows platform specifiers to CMake -A arguments
 PLAT_TO_CMAKE = {
@@ -124,14 +124,19 @@ def build_extension(self, ext):
 #         ),
 # ]
 
+from pathlib import Path
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
 setup(
     name="monilogger",
     version=__version__,
     author="Dorian Leroy",
     author_email="[email protected]",
     url="https://github.com/cea-hpc/monilogger",
     description="A Python logging and monitoring toolbox for C++ applications.",
-    long_description="",
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     packages=["monilogger"],
     package_dir={"": "src/api"},
     package_data={

src/api/MoniLogger.cc

@@ -245,7 +245,7 @@ namespace MoniLogger
         }
     }
 
-    void bootstrap_monilogger(std::vector<std::string> python_path,
+    void initialize_monilogger(std::vector<std::string> python_path,
         std::vector<std::string> python_scripts,
         std::string interface_module,
         std::function<void (py::module_, py::object)> interface_module_initializer)
@@ -275,20 +275,3 @@ namespace MoniLogger
         }
     }
 }
-
-PYBIND11_MODULE(_monilogger, m) {
-    m.attr("__name__") = "monilogger._monilogger";
-	py::class_<MoniLogger::MoniLoggerExecutionContext, std::shared_ptr<MoniLogger::MoniLoggerExecutionContext>>(m, "MoniLoggerExecutionContext")
-        .def(py::init<>());
-    m.def("register", &MoniLogger::register_monilogger);
-    m.def("stop", &MoniLogger::unregister_monilogger);
-    m.def("define_event", &MoniLogger::register_composite_event);
-    m.def("define_basic_events", &MoniLogger::register_base_events);
-    m.def("get_basic-events", &MoniLogger::get_base_events);
-    m.def("emit_event", [](std::string event_name, std::shared_ptr<MoniLogger::MoniLoggerExecutionContext> scope)
-    {
-        MoniLogger::trigger(event_name, scope);
-    });
-}
-
-

src/api/monilogger/include/MoniLogger.h

@@ -50,7 +50,7 @@ namespace MoniLogger
     void trigger(size_t event_id, std::shared_ptr<MoniLoggerExecutionContext> scope);
 
     __attribute__((visibility("default")))
-    void bootstrap_monilogger(std::vector<std::string> python_path,
+    void initialize_monilogger(std::vector<std::string> python_path,
         std::vector<std::string> python_scripts,
         std::string interface_module,
         std::function<void (py::module_, py::object)> interface_module_initializer);

src/api/monilogger_module.cc

@@ -8,7 +8,7 @@ PYBIND11_MODULE(_monilogger, m) {
     m.def("stop", &MoniLogger::unregister_monilogger);
     m.def("define_event", &MoniLogger::register_composite_event);
     m.def("define_basic_events", &MoniLogger::register_base_events);
-    m.def("get_basic-events", &MoniLogger::get_base_events);
+    m.def("get_basic_events", &MoniLogger::get_base_events);
     m.def("emit_event", [](std::string event_name, std::shared_ptr<MoniLogger::MoniLoggerExecutionContext> scope)
     {
         MoniLogger::trigger(event_name, scope);

src/bindings/cpp/README.md

@@ -1,6 +1,6 @@
-# **Using monilogger in your C++ app**
+# Using monilogger in your C++ app
 
-## **Defining the execution events**
+## Defining the execution events
 
 ```cpp
 MoniLogger::register_base_events({
@@ -13,7 +13,7 @@ MoniLogger::register_base_events({
 MoniLogger::register_composite_event("SomeCompositeEvent", {"SomeEvent", "SomeOtherEvent"});
 ```
 
-## **Defining the exposed execution context**
+## Defining the exposed execution context
 
 ```cpp
 struct MyExecutionContext : MoniLogger::MoniLoggerExecutionContext
@@ -27,7 +27,7 @@ struct MyExecutionContext : MoniLogger::MoniLoggerExecutionContext
 };
 ```
 
-### **Exposing local variables**
+### Exposing local variables
 
 ```cpp
 struct MyExecutionContext : MoniLogger::MoniLoggerExecutionContext
@@ -41,7 +41,7 @@ struct MyExecutionContext : MoniLogger::MoniLoggerExecutionContext
 };
 ```
 
-### **Exposing class members**
+### Exposing class members
 
 ```cpp
 struct MyExecutionContext : MoniLogger::MoniLoggerExecutionContext
@@ -60,7 +60,7 @@ struct MyExecutionContext : MoniLogger::MoniLoggerExecutionContext
 };
 ```
 
-### **Exposing the context as a Python class**
+### Exposing the context as a Python class
 
 ```cpp
 // Initialization function for the interface module.
@@ -106,6 +106,11 @@ std::function<void (pybind11::module_, pybind11::object)> interface_module_initi
     // ...
 ```
 
+## Starting the Python interpreter and initializing monilogger
+
+```cpp
+MoniLogger::initialize_monilogger(python_path, python_scripts, interface_module, interface_module_initializer);
+```
 
 ## Triggering execution events
 

src/bindings/cpp/examples/simple-embedding/src/SimpleEmbedding.cc

@@ -59,7 +59,7 @@ int main()
 
     // Bootstrapping monilogger, consisting mainly of starting the Python interpreter, initializing
     // the monilogger module, and evaluating the provided scripts.
-    MoniLogger::bootstrap_monilogger(python_path, python_scripts, interface_module, interface_module_initializer);
+    MoniLogger::initialize_monilogger(python_path, python_scripts, interface_module, interface_module_initializer);
 
     double foo(0.0);
     ctx->foo = &foo;