openblockperf 0.0.3__tar.gz

openblockperf-0.0.3/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

openblockperf-0.0.3/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: openblockperf
+Version: 0.0.3
+Summary: The OpenBlockperf client
+Author-email: Manuel Schmidt <manuel.schmidt@cardanofoundation.org>
+Maintainer-email: Manuel Schmidt <manuel.schmidt@cardanofoundation.org>
+Project-URL: Homepage, https://github.com/cardano-foundation/openblockperf
+Project-URL: Bug Reports, https://github.com/cardano-foundation/openblockperf/issues
+Keywords: cardano,cardano-foundation,ops
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.8
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pydantic-settings>=2.8.0
+Requires-Dist: typer>=0.15.2
+Dynamic: license-file
+
+# OpenBlockperf Client
+
+The OpenBlockperf Client is a cli tool that collects various metrics from
+a cardano node. If you dont know what a cardano-node is or dont run one
+yourself, this tool is probably not for you.
+
+---
+
+Install OpenBlockperf using pip:
+
+```shell
+$ pip install openblockperf
+```
+
+## Get started
+
+* You will need a `cardano-node` and and the `cardano-tracer` up and running.
+* Set the network via the `NETWORK` environment variable.
+* If you have not yet started to use uv i highly recommend you do. See https://docs.astral.sh/uv/getting-started/installation/
+
+```shell
+export NETWORK="mainnet"
+blockperf run
+```
+
+## Dependencies
+
+We have tried to keep the dependencies as little as possible. Thi
+
+  * `typer` - We use typer to implement the cli interface
+  * `click` - Typer itself relies on the click library
+  * `pydantic` - For json (and other data) validation
+  * `pydantic-settings` - For the applications configuration
+

openblockperf-0.0.3/README.md

@@ -0,0 +1,34 @@
+# OpenBlockperf Client
+
+The OpenBlockperf Client is a cli tool that collects various metrics from
+a cardano node. If you dont know what a cardano-node is or dont run one
+yourself, this tool is probably not for you.
+
+---
+
+Install OpenBlockperf using pip:
+
+```shell
+$ pip install openblockperf
+```
+
+## Get started
+
+* You will need a `cardano-node` and and the `cardano-tracer` up and running.
+* Set the network via the `NETWORK` environment variable.
+* If you have not yet started to use uv i highly recommend you do. See https://docs.astral.sh/uv/getting-started/installation/
+
+```shell
+export NETWORK="mainnet"
+blockperf run
+```
+
+## Dependencies
+
+We have tried to keep the dependencies as little as possible. Thi
+
+  * `typer` - We use typer to implement the cli interface
+  * `click` - Typer itself relies on the click library
+  * `pydantic` - For json (and other data) validation
+  * `pydantic-settings` - For the applications configuration
+

openblockperf-0.0.3/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "openblockperf"
+version = "0.0.3"
+description = "The OpenBlockperf client"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "click>=8.1.8",
+    "pydantic>=2.10.6",
+    "pydantic-settings>=2.8.0",
+    "typer>=0.15.2",
+]
+keywords = ["cardano", "cardano-foundation", "ops"]
+authors = [
+  {name = "Manuel Schmidt", email = "manuel.schmidt@cardanofoundation.org" },
+]
+maintainers = [
+  {name = "Manuel Schmidt", email = "manuel.schmidt@cardanofoundation.org" },
+]
+
+[project.scripts]
+blockperf = "blockperf.main:run"
+
+[project.urls]
+"Homepage" = "https://github.com/cardano-foundation/openblockperf"
+"Bug Reports" = "https://github.com/cardano-foundation/openblockperf/issues"
+
+[dependency-groups]
+dev = [
+    "ipython>=9.5.0",
+    "pudb>=2025.1",
+    "pytest>=8.4.2",
+]
+
+[tool.mypy]
+ignore_missing_imports = true
+
+# Provide test pypi index configuration for use with uv publish --index testpypi
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true
+
+[tool.ruff]
+# Enable all rules by default, then selectively disable
+select = ["E", "F", "W", "I", "N", "UP", "B", "A", "C4", "SIM", "PL"]
+ignore = ["E501"]  # Ignore line length violations
+# Assume Python 3.12
+target-version = "py312"
+
+# Exclude a variety of commonly ignored directories
+exclude = [
+    ".git",
+    ".mypy_cache",
+    ".ruff_cache",
+    ".venv",
+    "__pycache__",
+]
+
+# Set the line length to 88 (match black)
+line-length = 80
+
+# Sort imports
+[tool.ruff.isort]
+known-first-party = ["app", "cli"]
+
+#[tool.ruff.lint]
+#extend-select = ["E", "W", "F", "B"]
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Docstring settings
+[tool.ruff.pydocstyle]
+convention = "google"  # Or "numpy", "pep257"

openblockperf-0.0.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

openblockperf-0.0.3/src/blockperf/__init__.py

@@ -0,0 +1,19 @@
+# Version information for blockperf
+# Version is read from pyproject.toml - edit the version there
+
+import tomllib
+from pathlib import Path
+
+
+def _get_version():
+    """Read version from pyproject.toml"""
+    pyproject_path = Path(__file__).parent.parent.parent / "pyproject.toml"
+    try:
+        with open(pyproject_path, "rb") as f:
+            pyproject = tomllib.load(f)
+        return pyproject["project"]["version"]
+    except Exception:
+        return "unknown"
+
+
+__version__ = _get_version()

openblockperf-0.0.3/src/blockperf/cli.py

@@ -0,0 +1,32 @@
+"""Setup the cli by creating the main Typer application (blockperf_app) and
+adding the (sub)commands to it."""
+
+import typer
+from rich.console import Console
+
+from blockperf.commands.analyze import analyze_app
+from blockperf.commands.base import version_cmd
+from blockperf.commands.monitor import monitor_app
+from blockperf.commands.run import run_app
+
+console = Console()
+
+
+# Initialize the Typer application
+blockperf_app = typer.Typer(
+    name="blockperf",
+    help="A CLI application for block performance analysis",
+    add_completion=True,
+    no_args_is_help=True,
+)
+
+# Add base commands directly to the app
+blockperf_app.command("version")(version_cmd)
+blockperf_app.add_typer(analyze_app)
+blockperf_app.add_typer(monitor_app)
+blockperf_app.add_typer(run_app)
+
+
+def mycallback():
+    """Creates a single user Hiro Hamada. In the next version it will create 5 more users."""
+    console.print("Y A Y")

openblockperf-0.0.3/src/blockperf/commands/__init__.py

@@ -0,0 +1,5 @@
+"""Command modules for the BlockPerf CLI."""
+
+from blockperf.commands import base
+
+__all__ = ["base"]

openblockperf-0.0.3/src/blockperf/commands/analyze.py

@@ -0,0 +1,60 @@
+import asyncio
+import random
+
+import typer
+from rich.console import Console
+
+from blockperf.core.async_utils import run_async
+
+console = Console()
+
+analyze_app = typer.Typer(
+    name="analyze",
+    help="Performance analysis commands",
+)
+
+
+@analyze_app.command(name="blocks")
+def analyze_blocks(
+    blocks: int = typer.Option(
+        10, "--blocks", "-b", help="Number of blocks to analyze"
+    ),
+    network: str = typer.Option(
+        "mainnet", "--network", "-n", help="Network to analyze"
+    ),
+    timeout: int = typer.Option(
+        60, "--timeout", "-t", help="Timeout in seconds"
+    ),
+) -> None:
+    """Analyze a number of blocks for performance metrics.
+
+    Args:
+        blocks: Number of blocks to analyze
+        network: Network to analyze blocks from
+        timeout: Timeout in seconds for analysis operations
+    """
+    run_async(_analyze_blocks_async(blocks, network, timeout))
+
+
+async def _analyze_blocks_async(
+    blocks: int, network: str, timeout: int
+) -> None:
+    """Async implementation of block analysis.
+
+    Args:
+        blocks: Number of blocks to analyze
+        network: Network to analyze blocks from
+        timeout: Timeout in seconds for analysis operations
+    """
+    console.print(
+        f"Analyzing [bold]{blocks}[/] blocks on [bold]{network}[/]..."
+    )
+
+    # Simulate work with asyncio
+    for i in range(blocks):
+        console.print(f"Processing block {i + 1}/{blocks}")
+        await asyncio.sleep(
+            random.uniform(0.1, 6)
+        )  # Simulate network or processing delay
+
+    console.print("[bold green]Analysis complete![/]")

openblockperf-0.0.3/src/blockperf/commands/base.py

@@ -0,0 +1,25 @@
+"""Base commands implementation for BlockPerf CLI."""
+
+import typer
+from rich.console import Console
+
+from blockperf import __version__
+
+console = Console()
+
+
+def version_cmd(verbose: bool = False) -> None:
+    """Display the version of BlockPerf.
+
+    Args:
+        verbose: Display more detailed version information
+    """
+    console.print(f"BlockPerf version: [bold green]{__version__}[/]")
+
+    if verbose:
+        console.print("\n[bold]Environment:[/]")
+        import platform
+        import sys
+
+        console.print(f"Python version: [cyan]{sys.version}[/]")
+        console.print(f"Platform: [cyan]{platform.platform()}[/]")

openblockperf-0.0.3/src/blockperf/commands/monitor.py

@@ -0,0 +1,87 @@
+import asyncio
+import time
+
+import typer
+from rich.console import Console
+from rich.progress import Progress, SpinnerColumn, TextColumn, TimeElapsedColumn
+
+from blockperf.core.async_utils import run_async
+
+console = Console()
+
+
+# Create the monitor command group
+monitor_app = typer.Typer(
+    name="monitor",
+    help="Real-time monitoring commands",
+    invoke_without_command=True,
+)
+
+
+@monitor_app.callback()
+def monitor_app_callback(verboze: bool = False):
+    pass
+
+
+@monitor_app.command(name="blocks")
+def monitor_blocks(
+    duration: int = typer.Option(
+        0,
+        "--duration",
+        "-d",
+        help="Duration to monitor in seconds (0 for indefinite)",
+    ),
+    network: str = typer.Option(
+        "mainnet", "--network", "-n", help="Network to monitor"
+    ),
+) -> None:
+    """Monitor blocks in real-time.
+
+    Args:
+        duration: Duration to monitor in seconds (0 for indefinite)
+        network: Network to monitor blocks from
+    """
+    try:
+        run_async(_monitor_blocks_async(duration, network))
+    except KeyboardInterrupt:
+        console.print("\n[bold yellow]Monitoring stopped.[/]")
+
+
+async def _monitor_blocks_async(duration: int, network: str) -> None:
+    """Async implementation of block monitoring.
+
+    Args:
+        duration: Duration to monitor in seconds (0 for indefinite)
+        network: Network to monitor blocks from
+    """
+    start_time = time.time()
+    block_count = 0
+
+    with Progress(
+        SpinnerColumn(),
+        TextColumn("[bold blue]Monitoring blocks..."),
+        TimeElapsedColumn(),
+        console=console,
+    ) as progress:
+        task = progress.add_task(
+            "Monitoring", total=duration if duration > 0 else None
+        )
+
+        while True:
+            # Check if we've reached the duration
+            if duration > 0:
+                elapsed = time.time() - start_time
+                progress.update(task, completed=elapsed)
+                if elapsed >= duration:
+                    break
+
+            # Simulate receiving a new block
+            block_count += 1
+            console.print(f"New block received: #{block_count} on {network}")
+
+            # Wait for next block
+            await asyncio.sleep(2)  # Simulate block time
+
+    console.print(
+        f"[bold green]Monitoring complete! Observed {block_count} blocks.[/]"
+    )

openblockperf-0.0.3/src/blockperf/commands/run.py

@@ -0,0 +1,48 @@
+import asyncio
+from datetime import datetime
+
+import rich
+import typer
+from rich.console import Console
+
+from blockperf.core.async_utils import run_async
+from blockperf.core.config import settings
+from blockperf.core.eventprocessor import EventProcessor
+from blockperf.core.logreader import create_log_reader
+
+console = Console()
+
+run_app = typer.Typer(
+    name="run",
+    help="Run the blockperf client",
+    invoke_without_command=True,
+)
+
+
+@run_app.callback()
+def run_app_callback():
+    """Runs the blockperf client.
+
+    Creates a log reader first and then the event processor. The event
+    processor uses the log reader to read log events and process them.
+    The event processor is run inside an asyncio
+    """
+    try:
+        rich.print(
+            f"[bold]Network[/]: [color red]{settings().network.value.capitalize()}[/] [bold]Magic[/]: {settings().network_config.magic} [bold]Startime[/]: {datetime.fromtimestamp(settings().network_config.starttime).isoformat()}",
+        )
+
+        log_reader = create_log_reader("journalctl", "cardano-tracer")
+        event_processor = EventProcessor(log_reader=log_reader)
+        run_async(_run_event_processor(event_processor))
+    except KeyboardInterrupt:
+        console.print("\n[bold yellow]Monitoring stopped.[/]")
+
+
+async def _run_event_processor(event_processor: EventProcessor):
+    """Asyncronously run the given event processor."""
+    try:
+        event_processor_task = asyncio.create_task(event_processor.start())
+        await event_processor_task
+    except asyncio.CancelledError:
+        await event_processor.stop()

openblockperf-0.0.3/src/blockperf/core/__init__.py

@@ -0,0 +1,5 @@
+"""Core functionality modules for BlockPerf."""
+
+from blockperf.core import async_utils
+
+__all__ = ["async_utils"]