formatting

Author: guenp

.devcontainer/devcontainer.json

@@ -1,40 +1,40 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.245.0/containers/python-3
 {
-    "name": "Python 3",
-    "image": "mcr.microsoft.com/devcontainers/python:3.11-bullseye",
+  "name": "Python 3",
+  "image": "mcr.microsoft.com/devcontainers/python:3.11-bullseye",
 
-    // Configure tool-specific properties.
-    "customizations": {
-        // Configure properties specific to VS Code.
-        "vscode": {
-            // Set *default* container specific settings.json values on container create.
-            "settings": {
-                "python.defaultInterpreterPath": "/usr/local/bin/python",
-                "python.testing.pytestEnabled": true,
-                "python.testing.unittestEnabled": false,
-                "files.exclude": {
-                    ".coverage": true,
-                    ".pytest_cache": true,
-                    "__pycache__": true
-                }
-            },
-
-            // Add the IDs of extensions you want installed when the container is created.
-            "extensions": [
-                "ms-python.python",
-                "charliermarsh.ruff",
-                "ms-python.black-formatter"
-            ]
+  // Configure tool-specific properties.
+  "customizations": {
+    // Configure properties specific to VS Code.
+    "vscode": {
+      // Set *default* container specific settings.json values on container create.
+      "settings": {
+        "python.defaultInterpreterPath": "/usr/local/bin/python",
+        "python.testing.pytestEnabled": true,
+        "python.testing.unittestEnabled": false,
+        "files.exclude": {
+          ".coverage": true,
+          ".pytest_cache": true,
+          "__pycache__": true
         }
-    },
+      },
+
+      // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        "ms-python.python",
+        "charliermarsh.ruff",
+        "ms-python.black-formatter"
+      ]
+    }
+  },
 
-    // Use 'forwardPorts' to make a list of ports inside the container available locally.
-    // "forwardPorts": [],
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
 
-    // Use 'postCreateCommand' to run commands after the container is created.
-    "postCreateCommand": "pip3 install --user -r requirements-dev.txt && pre-commit install",
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "pip3 install --user -r requirements-dev.txt && pre-commit install",
 
-    // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
-    "remoteUser": "vscode"
+  // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "remoteUser": "vscode"
 }

CHANGELOG.md

@@ -1,13 +1,17 @@
 ## [project-title] Changelog
 
 <a name="x.y.z"></a>
+
 # x.y.z (yyyy-mm-dd)
 
-*Features*
-* ...
+_Features_
+
+- ...
+
+_Bug Fixes_
+
+- ...
 
-*Bug Fixes*
-* ...
+_Breaking Changes_
 
-*Breaking Changes*
-* ...
+- ...

CONTRIBUTING.md

@@ -1,72 +1,93 @@
 # Contributing to [project-title]
 
-This project welcomes contributions and suggestions.  Most contributions require you to agree to a
-Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
-
-When you submit a pull request, a CLA bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
-provided by the bot. You will only need to do this once across all repos using our CLA.
-
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
-
- - [Code of Conduct](#coc)
- - [Issues and Bugs](#issue)
- - [Feature Requests](#feature)
- - [Submission Guidelines](#submit)
+This project welcomes contributions and suggestions. Most contributions require
+you to agree to a Contributor License Agreement (CLA) declaring that you have
+the right to, and actually do, grant us the rights to use your contribution. For
+details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether
+you need to provide a CLA and decorate the PR appropriately (e.g., status check,
+comment). Simply follow the instructions provided by the bot. You will only need
+to do this once across all repos using our CLA.
+
+This project has adopted the
+[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the
+[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any
+additional questions or comments.
+
+- [Code of Conduct](#coc)
+- [Issues and Bugs](#issue)
+- [Feature Requests](#feature)
+- [Submission Guidelines](#submit)
 
 ## <a name="coc"></a> Code of Conduct
-Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Help us keep this project open and inclusive. Please read and follow our
+[Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 
 ## <a name="issue"></a> Found an Issue?
-If you find a bug in the source code or a mistake in the documentation, you can help us by
-[submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can
-[submit a Pull Request](#submit-pr) with a fix.
+
+If you find a bug in the source code or a mistake in the documentation, you can
+help us by [submitting an issue](#submit-issue) to the GitHub Repository. Even
+better, you can [submit a Pull Request](#submit-pr) with a fix.
 
 ## <a name="feature"></a> Want a Feature?
-You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub
-Repository. If you would like to *implement* a new feature, please submit an issue with
-a proposal for your work first, to be sure that we can use it.
 
-* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
+You can _request_ a new feature by [submitting an issue](#submit-issue) to the
+GitHub Repository. If you would like to _implement_ a new feature, please submit
+an issue with a proposal for your work first, to be sure that we can use it.
+
+- **Small Features** can be crafted and directly
+  [submitted as a Pull Request](#submit-pr).
 
 ## <a name="submit"></a> Submission Guidelines
 
 ### <a name="submit-issue"></a> Submitting an Issue
-Before you submit an issue, search the archive, maybe your question was already answered.
+
+Before you submit an issue, search the archive, maybe your question was already
+answered.
 
 If your issue appears to be a bug, and hasn't been reported, open a new issue.
 Help us to maximize the effort we can spend fixing issues and adding new
-features, by not reporting duplicate issues.  Providing the following information will increase the
-chances of your issue being dealt with quickly:
-
-* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
-* **Version** - what version is affected (e.g. 0.1.2)
-* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
-* **Browsers and Operating System** - is this a problem with all browsers?
-* **Reproduce the Error** - provide a live example or a unambiguous set of steps
-* **Related Issues** - has a similar issue been reported before?
-* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
-  causing the problem (line of code or commit)
-
-You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/[organization-name]/[repository-name]/issues/new].
+features, by not reporting duplicate issues. Providing the following information
+will increase the chances of your issue being dealt with quickly:
+
+- **Overview of the Issue** - if an error is being thrown a non-minified stack
+  trace helps
+- **Version** - what version is affected (e.g. 0.1.2)
+- **Motivation for or Use Case** - explain what are you trying to do and why the
+  current behavior is a bug for you
+- **Browsers and Operating System** - is this a problem with all browsers?
+- **Reproduce the Error** - provide a live example or a unambiguous set of steps
+- **Related Issues** - has a similar issue been reported before?
+- **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point
+  to what might be causing the problem (line of code or commit)
+
+You can file new issues by providing the above information at the corresponding
+repository's issues link:
+https://github.com/[organization-name]/[repository-name]/issues/new].
 
 ### <a name="submit-pr"></a> Submitting a Pull Request (PR)
+
 Before you submit your Pull Request (PR) consider the following guidelines:
 
-* Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR
-  that relates to your submission. You don't want to duplicate effort.
+- Search the repository
+  (https://github.com/[organization-name]/[repository-name]/pulls) for an open
+  or closed PR that relates to your submission. You don't want to duplicate
+  effort.
+
+- Make your changes in a new git fork:
 
-* Make your changes in a new git fork:
+- Commit your changes using a descriptive commit message
+- Push your fork to GitHub:
+- In GitHub, create a pull request
+- If we suggest changes then:
 
-* Commit your changes using a descriptive commit message
-* Push your fork to GitHub:
-* In GitHub, create a pull request
-* If we suggest changes then:
-  * Make the required updates.
-  * Rebase your fork and force push to your GitHub repository (this will update your Pull Request):
+  - Make the required updates.
+  - Rebase your fork and force push to your GitHub repository (this will update
+    your Pull Request):
 
     ```shell
     git rebase master -i

README.md

@@ -26,7 +26,8 @@
 
 <!-- prettier-ignore-end -->
 
-This library adds basic telemetry to Python projects that traces the usage and run time of Python functions within a given scope.
+This library adds basic telemetry to Python projects that traces the usage and
+run time of Python functions within a given scope.
 
 ## Installation
 
@@ -46,16 +47,13 @@ To track usage of one or more existing Python projects, run:
 from opentelemetry.instrumentation.auto_instrumentation import initialize
 from telemetric import install
 
-install(
-  [
-    my_project.my_module
-  ]
-)
+install([my_project.my_module])
 initialize()
-start_span_processor('my-project-service')
+start_span_processor("my-project-service")
 ```
 
-To explicitly add instrumentation to functions you want to trace, use the `span` decorator:
+To explicitly add instrumentation to functions you want to trace, use the `span`
+decorator:
 
 ```python
 from telemetric import span, start_span_processor
@@ -65,14 +63,16 @@ from telemetric import span, start_span_processor
 def foo(bar):
     print(bar)
 
+
 if __name__ == "__main__":
     start_span_processor("test-service")
     foo(bar="baz")
 ```
 
 ## Start collector
 
-To start a collector that prints each log message to stdout, run `cd tests/collector` and run
+To start a collector that prints each log message to stdout, run
+`cd tests/collector` and run
 
 ```bash
 docker run -p 4317:4317 -p 4318:4318 --rm -v $(pwd)/collector-config.yaml:/etc/otelcol/config.yaml otel/opentelemetry-collector
@@ -88,5 +88,3 @@ docker run --name jaeger \
   -p 4318:4318 \
   jaegertracing/all-in-one:1.35
 ```
-
-

build.py

@@ -7,10 +7,10 @@
 
 class CustomBuildHook(BuildHookInterface):
     def initialize(self, version, build_data):
-        build_data['ext_modules'] = [
+        build_data["ext_modules"] = [
             Extension(
                 "telemetric._stats_wrapper",
                 ["src/telemetric/_stats_wrapper.c"],
             ),
         ]
-        build_data['cmdclass'] = {"build_ext": build_ext} 
+        build_data["cmdclass"] = {"build_ext": build_ext}

examples/test_scipy.ipynb

@@ -28,7 +28,23 @@
     "scrolled": true
    },
    "outputs": [],
-   "source": "from opentelemetry.instrumentation.auto_instrumentation import initialize\n\nfrom telemetric import install\nfrom telemetric.console import setup_console\n\n# Set up which modules should be instrumented\ninstall([\n    \"scipy.stats._correlation\",\n    \"scipy.stats._distn_infrastructure\"\n])\n\n# Set up Grafana Cloud logging\ninitialize()\n\n# Set up Console logging\nsetup_console()"
+   "source": [
+    "from __future__ import annotations\n",
+    "\n",
+    "from opentelemetry.instrumentation.auto_instrumentation import initialize\n",
+    "\n",
+    "from telemetric import install\n",
+    "from telemetric.console import setup_console\n",
+    "\n",
+    "# Set up which modules should be instrumented\n",
+    "install([\"scipy.stats._correlation\", \"scipy.stats._distn_infrastructure\"])\n",
+    "\n",
+    "# Set up Grafana Cloud logging\n",
+    "initialize()\n",
+    "\n",
+    "# Set up Console logging\n",
+    "setup_console()"
+   ]
   },
   {
    "cell_type": "code",
@@ -92,4 +108,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}

examples/test_scipy.py

@@ -1,4 +1,6 @@
 # from opentelemetry.instrumentation.auto_instrumentation import initialize
+from __future__ import annotations
+
 from telemetric import install
 
 # from telemetric.console import setup_console
@@ -21,7 +23,7 @@
 # How many calls (errors, and how often something was odd with the args)
 print("counts: ", stats.norm.pdf._get_counts())
 
-# Detailed statics for each parameter.  How often was it passed
+# Detailed statistics for each parameter.  How often was it passed
 # and how often were "a" and 3 passed (or something equal to them,
 # I do not consider types right now, although one could)?
 print("param stats: ", stats.norm.pdf._get_param_stats())

examples/test_span.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from time import sleep
 
 from telemetric.console import setup_console

examples/test_stats_uploader.py

@@ -1,9 +1,11 @@
 """Test script for the stats uploader module"""
 
+from __future__ import annotations
+
 import logging
 
-from telemetric.statswrapper import stats_deco
 from telemetric.ga4.stats_uploader import StatsUploader
+from telemetric.statswrapper import stats_deco
 
 logging.basicConfig(level=logging.DEBUG)
 
@@ -45,7 +47,9 @@ def another_func(x=1, y=True):
 print("=== Testing Stats Uploader ===")
 
 # Use a dummy proxy URL for testing (won't actually send data unless configured)
-uploader = StatsUploader(proxy_url="https://analytics-proxy-production-665e.up.railway.app")
+uploader = StatsUploader(
+    proxy_url="https://analytics-proxy-production-665e.up.railway.app"
+)
 
 print("Analytics client enabled:", uploader.analytics.enabled)
 
@@ -65,9 +69,7 @@ def another_func(x=1, y=True):
 
 # Test custom stats upload
 print("\nUploading custom stats...")
-custom_result = uploader.upload_custom_stats("custom_metric", {
-    "metric_name": "test_metric", 
-    "value": 42,
-    "category": "testing"
-})
+custom_result = uploader.upload_custom_stats(
+    "custom_metric", {"metric_name": "test_metric", "value": 42, "category": "testing"}
+)
 print("Custom upload result:", custom_result)