smf2db 0.1.0__tar.gz

smf2db-0.1.0/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2026 franfcwong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

smf2db-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: smf2db
+Version: 0.1.0
+Summary: A CLI application that does upload SMF JSON files to database, summarization and printing reports on the fly without any DBMS.
+Author-email: Fran Wong <franfcwong@hotmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/franfcwong/smf2db
+Project-URL: Documentation, https://smf2db.readthedocs.io
+Keywords: SMF,z/OS
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: click>=8.1.3
+Requires-Dist: numpy>=1.23.4
+Requires-Dist: pandas>=1.5.1
+Requires-Dist: SQLAlchemy>=2.0.12
+Requires-Dist: rich>=14.3.2
+Requires-Dist: tabulate==0.9.0
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: jsonschema>=4.17.3
+Requires-Dist: packaging>=25.0
+Provides-Extra: ssh
+Requires-Dist: sshtunnel>=0.4.0; extra == "ssh"
+Requires-Dist: paramiko==3.5.0; extra == "ssh"
+Provides-Extra: psycopg2
+Requires-Dist: psycopg2>=2.9; extra == "psycopg2"
+Dynamic: license-file
+
+# smf2db
+
+![Pypi](https://img.shields.io/badge/Pypi-0.1.0-blue)
+![coverage](https://img.shields.io/badge/coverage-93%25-yellowgreen)
+[![Documentation Status](https://readthedocs.org/projects/smf2db/badge/?version=latest)](https://smf2db.readthedocs.io)
+[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
+
+This is a CLI application that does upload SMF JSON files to database, summarization and printing reports on the fly without any DBMS.
+
+
+![]()
+
+**Table of Contents**
+
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Technologies](#technologies)
+- [Features](#features)
+- [Contact](#contact)
+- [Change log](#change-log)
+- [License](#license)
+
+## Prerequisites
+
+Before you begin, ensure you have met the following requirements:
+* Python 3.11 or later installed on your platform
+* Ensure you have created a virtual environment
+* Get ready of SMF JSON files (you can follow the instructions of my another project in [CBTTape](https://cbttape.org/ftp/cbt/CBT1064.zip)) 
+
+## Installation
+
+**smf2db** is officially distributed for installation through [PyPI](https://pypi.org/project/smf2db) for installation with pip.
+To install **smf2db**, follow these steps:
+
+### On z/OS:
+
+Ensure you download the wheel file and upload to USS before beginning. The requirements for intalling`smf2db`are as follows:
+- Python installed
+- Can access [Python AI Tookit for IBM z/OS](https://ibm-z-oss-oda.github.io/python_ai_toolkit_zos/) to get pre-built Python packages for z/OS.
+- Can access [PyPI](https://pypi.org) to get other dependent packages. It is optional as the required wheel files will be included in the pax file when expanding it.
+
+If installing from wheel file, you can run this:
+```
+python -m pip install smf2db-0.1.0-py3-none-any.whl
+```
+
+For more detail instructions, please refer to the project's official [documentation](https://smf2db.readthedocs.io).
+
+### On macOS, Linux and Windows:
+**smf2db** can be installed with [pip](htps://pip.pypa.io/len/stable/) like this:
+
+```
+python -m pip install smf2db
+```
+
+## Usage
+
+### On z/OS:
+There are two methods to run smf2db:
+- Using batch job
+- firing up a telnet terminal window and run the following command:
+    ```
+    $ smf2db --version
+    ``` 
+
+### On macOS, Linux and Windows:
+You can just run the following command on the terminal:
+```
+$ smf2db --version
+```
+
+Here are flowchart of how to use the smf2db:
+
+```mermaid
+graph TD;
+    smf2db-->report;
+    smf2db-->db;
+    db-->initcfg;
+    initcfg-->initdb;
+    initdb-->initsum;
+    initdb-->upload;
+    initsum-->sumup;
+```
+
+### Usage Examples
+
+If you have some smf70 JSON data on hand for the LPAR, e.g. ``S0W1``, in ``json_data`` directory, you can just print the report on the fly 
+by running the following command without any DBMS involvement:
+```
+smf2db report 70 json_data/smf70.json -r 'CPU Activity report' -l S0W1
+```
+
+If you would like to upload data to DBMS, say, SQLite, you are required to run ``db initcfg`` to create a yaml 
+configuration file first. Here we will create a ``config.yaml`` in ``configs`` directory with the SQLite db path 
+in ``data`` directory which has already created. The ``partition scheme`` is a single database without any partition and 
+without any prefix for the database names. The command is shown below:
+```
+smf2db db initcfg --config_file configs/config.yaml --db_driver sqlite --sqlite_path data --partitions 'no partition' -x ''
+```
+
+After creation of the configuration file, you can now initialize the database in SQLite by creating the tables in 
+the database. Let's initialzie smf type 70:
+```
+smf2db db initdb 70 --config_file configs/config.yaml
+```
+
+To upload smf70 JSON data in ``json_data/smf70.json`` to SQLite, you can simply run:
+```
+smf2db db upload 70 json_data/smf70.json --config_file configs/config.yaml
+```
+
+For more detail how to use it, please refer to the project's official [documentation page](https://smf2db.readthedocs.io).
+
+## Technologies
+
+**smf2db** uses the following technologies and tools:
+
+- [Python](https://www.python.org/): ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+- [SQLAlchemy](https://www.sqlalchemy.org/): ![SQLAlchemy](https://img.shields.io/badge/sqlalchemy-%2307405e.svg?style=for-the-badge&logo=sqlalchemy&logoColor=red)
+- [PostgreSQL](https://www.postgresql.org/): ![PostgreSQL](https://img.shields.io/badge/postgresql-%2307405e.svg?style=for-the-badge&logo=postgresql&logoColor=white)
+
+## Features
+
+**smf2db** currently supports SMF types 30, 70-75, 77, 78, 110 and 123 and has the following
+set of features:
+
+- Printing reports on the fly using the JSON files as input without loading to DBMS. It is 
+  recommended to output the report to a file for easier browsing.
+- Uploading JSON files to Database (SQLite or Postgresql). You can use SSH to connect to 
+  Postgresql if SSH is supported on your platform.
+- Suming up data to hourly or daily database. 15-minutes sum-up is available for some
+  SMF types.
+
+## Contact
+
+If you want to contact me you can reach me at <franfwong@hotmail.com>.
+
+## Change log
+
+- 0.1.0
+    - The first proper release
+
+## License
+
+This project uses the following license: [`LICENSE`](LICENSE.md).

smf2db-0.1.0/README.md

@@ -0,0 +1,146 @@
+# smf2db
+
+![Pypi](https://img.shields.io/badge/Pypi-0.1.0-blue)
+![coverage](https://img.shields.io/badge/coverage-93%25-yellowgreen)
+[![Documentation Status](https://readthedocs.org/projects/smf2db/badge/?version=latest)](https://smf2db.readthedocs.io)
+[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
+
+This is a CLI application that does upload SMF JSON files to database, summarization and printing reports on the fly without any DBMS.
+
+
+![]()
+
+**Table of Contents**
+
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Technologies](#technologies)
+- [Features](#features)
+- [Contact](#contact)
+- [Change log](#change-log)
+- [License](#license)
+
+## Prerequisites
+
+Before you begin, ensure you have met the following requirements:
+* Python 3.11 or later installed on your platform
+* Ensure you have created a virtual environment
+* Get ready of SMF JSON files (you can follow the instructions of my another project in [CBTTape](https://cbttape.org/ftp/cbt/CBT1064.zip)) 
+
+## Installation
+
+**smf2db** is officially distributed for installation through [PyPI](https://pypi.org/project/smf2db) for installation with pip.
+To install **smf2db**, follow these steps:
+
+### On z/OS:
+
+Ensure you download the wheel file and upload to USS before beginning. The requirements for intalling`smf2db`are as follows:
+- Python installed
+- Can access [Python AI Tookit for IBM z/OS](https://ibm-z-oss-oda.github.io/python_ai_toolkit_zos/) to get pre-built Python packages for z/OS.
+- Can access [PyPI](https://pypi.org) to get other dependent packages. It is optional as the required wheel files will be included in the pax file when expanding it.
+
+If installing from wheel file, you can run this:
+```
+python -m pip install smf2db-0.1.0-py3-none-any.whl
+```
+
+For more detail instructions, please refer to the project's official [documentation](https://smf2db.readthedocs.io).
+
+### On macOS, Linux and Windows:
+**smf2db** can be installed with [pip](htps://pip.pypa.io/len/stable/) like this:
+
+```
+python -m pip install smf2db
+```
+
+## Usage
+
+### On z/OS:
+There are two methods to run smf2db:
+- Using batch job
+- firing up a telnet terminal window and run the following command:
+    ```
+    $ smf2db --version
+    ``` 
+
+### On macOS, Linux and Windows:
+You can just run the following command on the terminal:
+```
+$ smf2db --version
+```
+
+Here are flowchart of how to use the smf2db:
+
+```mermaid
+graph TD;
+    smf2db-->report;
+    smf2db-->db;
+    db-->initcfg;
+    initcfg-->initdb;
+    initdb-->initsum;
+    initdb-->upload;
+    initsum-->sumup;
+```
+
+### Usage Examples
+
+If you have some smf70 JSON data on hand for the LPAR, e.g. ``S0W1``, in ``json_data`` directory, you can just print the report on the fly 
+by running the following command without any DBMS involvement:
+```
+smf2db report 70 json_data/smf70.json -r 'CPU Activity report' -l S0W1
+```
+
+If you would like to upload data to DBMS, say, SQLite, you are required to run ``db initcfg`` to create a yaml 
+configuration file first. Here we will create a ``config.yaml`` in ``configs`` directory with the SQLite db path 
+in ``data`` directory which has already created. The ``partition scheme`` is a single database without any partition and 
+without any prefix for the database names. The command is shown below:
+```
+smf2db db initcfg --config_file configs/config.yaml --db_driver sqlite --sqlite_path data --partitions 'no partition' -x ''
+```
+
+After creation of the configuration file, you can now initialize the database in SQLite by creating the tables in 
+the database. Let's initialzie smf type 70:
+```
+smf2db db initdb 70 --config_file configs/config.yaml
+```
+
+To upload smf70 JSON data in ``json_data/smf70.json`` to SQLite, you can simply run:
+```
+smf2db db upload 70 json_data/smf70.json --config_file configs/config.yaml
+```
+
+For more detail how to use it, please refer to the project's official [documentation page](https://smf2db.readthedocs.io).
+
+## Technologies
+
+**smf2db** uses the following technologies and tools:
+
+- [Python](https://www.python.org/): ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+- [SQLAlchemy](https://www.sqlalchemy.org/): ![SQLAlchemy](https://img.shields.io/badge/sqlalchemy-%2307405e.svg?style=for-the-badge&logo=sqlalchemy&logoColor=red)
+- [PostgreSQL](https://www.postgresql.org/): ![PostgreSQL](https://img.shields.io/badge/postgresql-%2307405e.svg?style=for-the-badge&logo=postgresql&logoColor=white)
+
+## Features
+
+**smf2db** currently supports SMF types 30, 70-75, 77, 78, 110 and 123 and has the following
+set of features:
+
+- Printing reports on the fly using the JSON files as input without loading to DBMS. It is 
+  recommended to output the report to a file for easier browsing.
+- Uploading JSON files to Database (SQLite or Postgresql). You can use SSH to connect to 
+  Postgresql if SSH is supported on your platform.
+- Suming up data to hourly or daily database. 15-minutes sum-up is available for some
+  SMF types.
+
+## Contact
+
+If you want to contact me you can reach me at <franfwong@hotmail.com>.
+
+## Change log
+
+- 0.1.0
+    - The first proper release
+
+## License
+
+This project uses the following license: [`LICENSE`](LICENSE.md).

smf2db-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+# pyproject.toml
+
+[build-system]
+requires = ["setuptools>=73.0.1", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "smf2db"
+version = "0.1.0"
+requires-python = ">= 3.11"
+keywords = ["SMF", "z/OS"]
+description = "A CLI application that does upload SMF JSON files to database, summarization and printing reports on the fly without any DBMS."
+readme = "README.md"
+authors = [{name = "Fran Wong", email = "franfcwong@hotmail.com"}]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+dependencies = [
+    "click >= 8.1.3",
+    "numpy>=1.23.4",
+    "pandas>=1.5.1",
+    "SQLAlchemy>=2.0.12",
+    "rich>=14.3.2",
+    "tabulate==0.9.0",
+    "pyyaml>=6.0.3",
+    "jsonschema>=4.17.3",
+    "packaging>=25.0"
+]
+
+[project.optional-dependencies]
+ssh = [
+    "sshtunnel>=0.4.0",
+    "paramiko==3.5.0"
+]
+psycopg2 = ["psycopg2>=2.9"]
+
+[project.urls]
+Homepage = "https://github.com/franfcwong/smf2db"
+Documentation = 'https://smf2db.readthedocs.io'
+
+[project.scripts]
+smf2db = "smf2db.__main__:cli"
+
+[tool.setuptools.packages.find]
+where = ['src']

smf2db-0.1.0/setup.cfg

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

smf2db-0.1.0/src/smf2db/__init__.py

@@ -0,0 +1,30 @@
+"""Top-level package for Smf2db."""
+# smf2db/__init__.py
+
+__app_name__ = "smf2db"
+__version__ = "0.1.0"
+
+(
+    SUCCESS,
+    DIR_ERROR,
+    FILE_ERROR,
+    DB_READ_ERROR,
+    DB_WRITE_ERROR,
+    JSON_ERROR,
+    UPLOAD_ERROR,
+    DB_CONNECTION_ERROR,
+) = range(8)
+
+ERRORS = {
+    DIR_ERROR: "config directory error",
+    FILE_ERROR: "config file error",
+    DB_READ_ERROR: "database read error",
+    DB_WRITE_ERROR: "database write error",
+    JSON_ERROR: "Invalid JSON format error",
+    UPLOAD_ERROR: "uploading error",
+    DB_CONNECTION_ERROR: "database connection error",
+}
+
+DEFAULT_DB_HOST = 'localhost'
+DEFAULT_DB_PORT = 5432
+DEFAULT_DB_USER = 'postgres'