hammerAPI 0.1.0__tar.gz

hammerapi-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

hammerapi-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shayan Saha
+
+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.

hammerapi-0.1.0/PKG-INFO

@@ -0,0 +1,450 @@
+Metadata-Version: 2.4
+Name: hammerAPI
+Version: 0.1.0
+Summary: A lightweight, blazing-fast, multi-threaded API performance and load testing library for Python. HammerAPI allows you to orchestrate parallel API requests smoothly while automatically collecting cross-platform hardware telemetry (CPU/RAM usage) from your local machine, compiling everything into a self-contained, interactive HTML dashboard.
+Project-URL: Homepage, https://github.com/shayansaha85/hammerAPI
+Author-email: Shayan <shayan851997@gmail.com>
+License: MIT
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: psutil>=5.9.0
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="logo_readme.png" alt="hammerAPI">
+</p>
+
+
+[![Python Version](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://pypi.org/project/hammerapi/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A lightweight, blazing-fast, multi-threaded API performance and load testing library for Python.
+
+**HammerAPI** helps developers, QA engineers, SREs, and performance testers stress-test REST APIs with minimal code while automatically collecting local machine telemetry (CPU/RAM) and generating beautiful interactive HTML reports.
+
+---
+
+## 🚀 Installation
+
+```bash
+pip install hammerapi
+```
+
+---
+
+## ✨ Features
+
+### 🧵 Concurrent API Execution
+
+Run hundreds or thousands of requests using a configurable thread pool.
+
+### ⏱️ Multiple Execution Modes
+
+* Run each test case exactly once
+* Run continuously for a fixed duration
+* Mix multiple endpoints in the same workload
+
+### 🌐 Full HTTP Support
+
+Supports:
+
+* GET
+* POST
+* PUT
+* PATCH
+* DELETE
+
+### 🔐 Authentication Support
+
+Works with:
+
+* Bearer Tokens
+* API Keys
+* Custom Headers
+* Session Cookies
+
+### 📊 Performance Metrics
+
+Automatically captures:
+
+* Response Time
+* Success / Failure Counts
+* Request Throughput
+* Average Latency
+* P90 Latency
+* P95 Latency
+* P99 Latency
+
+### 🖥️ System Resource Monitoring
+
+Captures local machine:
+
+* CPU Utilization
+* RAM Utilization
+* Operating System Information
+
+### 📈 Interactive HTML Dashboard
+
+Generate beautiful standalone reports with:
+
+* Charts
+* Percentiles
+* Error Analysis
+* Resource Consumption Trends
+* Request Distribution
+
+### 🌍 Cross Platform
+
+Works on:
+
+* Windows
+* Linux
+* macOS
+
+---
+
+# 📁 Project Structure
+
+```text
+hammerAPI/
+├── LICENSE
+├── README.md
+├── pyproject.toml
+├── logo.png
+├── logo_readme.png
+├── src/
+│   └── hammerapi/
+│       ├── __init__.py
+│       ├── monitor.py
+│       ├── reporter.py
+│       └── runner.py
+└── examples/
+    ├── sample-code.py
+    ├── sample-report.html
+    └── sample-report.jpeg
+```
+
+---
+
+# Quick Start
+
+## Simple GET Request
+
+```python
+from hammerapi import HammerAPI
+
+hammer = HammerAPI(max_workers=5)
+
+hammer.add_test(
+    method="GET",
+    url="https://jsonplaceholder.typicode.com/posts/1"
+)
+
+hammer.run()
+
+hammer.generate_report()
+```
+
+---
+
+## Multiple Endpoints
+
+```python
+from hammerapi import HammerAPI
+
+hammer = HammerAPI(max_workers=10)
+
+hammer.add_test(
+    "GET",
+    "https://jsonplaceholder.typicode.com/posts/1"
+)
+
+hammer.add_test(
+    "GET",
+    "https://jsonplaceholder.typicode.com/users/1"
+)
+
+hammer.add_test(
+    "GET",
+    "https://jsonplaceholder.typicode.com/comments/1"
+)
+
+hammer.run()
+
+hammer.generate_report()
+```
+
+---
+
+## POST Request with JSON Payload
+
+```python
+from hammerapi import HammerAPI
+
+hammer = HammerAPI()
+
+hammer.add_test(
+    method="POST",
+    url="https://jsonplaceholder.typicode.com/posts",
+    json={
+        "title": "HammerAPI",
+        "body": "Load Testing",
+        "userId": 1
+    }
+)
+
+hammer.run()
+hammer.generate_report()
+```
+
+---
+
+## Authenticated API Testing
+
+```python
+from hammerapi import HammerAPI
+
+hammer = HammerAPI()
+
+hammer.add_test(
+    method="GET",
+    url="https://api.example.com/users",
+    headers={
+        "Authorization": "Bearer YOUR_TOKEN"
+    }
+)
+
+hammer.run()
+```
+
+---
+
+## API Key Authentication
+
+```python
+from hammerapi import HammerAPI
+
+hammer = HammerAPI()
+
+hammer.add_test(
+    method="GET",
+    url="https://api.example.com/data",
+    headers={
+        "x-api-key": "YOUR_API_KEY"
+    }
+)
+
+hammer.run()
+```
+
+---
+
+## Query Parameters
+
+```python
+from hammerapi import HammerAPI
+
+hammer = HammerAPI()
+
+hammer.add_test(
+    method="GET",
+    url="https://api.example.com/search",
+    params={
+        "page": 1,
+        "limit": 100
+    }
+)
+
+hammer.run()
+```
+
+---
+
+## Custom Headers
+
+```python
+from hammerapi import HammerAPI
+
+hammer = HammerAPI()
+
+hammer.add_test(
+    method="GET",
+    url="https://api.example.com/data",
+    headers={
+        "Environment": "QA",
+        "Client": "HammerAPI"
+    }
+)
+
+hammer.run()
+```
+
+---
+
+## PUT Request
+
+```python
+hammer.add_test(
+    method="PUT",
+    url="https://api.example.com/user/1",
+    json={
+        "name": "John Doe"
+    }
+)
+```
+
+---
+
+## PATCH Request
+
+```python
+hammer.add_test(
+    method="PATCH",
+    url="https://api.example.com/user/1",
+    json={
+        "status": "active"
+    }
+)
+```
+
+---
+
+## DELETE Request
+
+```python
+hammer.add_test(
+    method="DELETE",
+    url="https://api.example.com/user/1"
+)
+```
+
+---
+
+# 🔥 Load Testing For Fixed Duration
+
+Continuously hit endpoints for a specific duration.
+
+```python
+from hammerapi import HammerAPI
+
+hammer = HammerAPI(max_workers=25)
+
+hammer.add_test(
+    "GET",
+    "https://api.example.com/health"
+)
+
+hammer.run(duration_seconds=60)
+
+hammer.generate_report("load_test_report.html")
+```
+
+This will continuously execute requests across 25 worker threads for 60 seconds.
+
+---
+
+# ⚡ High Concurrency Example
+
+```python
+from hammerapi import HammerAPI
+
+hammer = HammerAPI(max_workers=100)
+
+hammer.add_test(
+    "GET",
+    "https://api.example.com/health"
+)
+
+hammer.run(duration_seconds=120)
+```
+
+Perfect for:
+
+* Load Testing
+* Stress Testing
+* Smoke Testing
+* Capacity Planning
+
+---
+
+# 📄 Generate Report
+
+```python
+hammer.generate_report(
+    output_path="hammer_report.html"
+)
+```
+
+Generated report includes:
+
+* Total Requests
+* Success Rate
+* Failure Rate
+* Average Response Time
+* P90 Latency
+* P95 Latency
+* P99 Latency
+* CPU Utilization
+* RAM Utilization
+* Throughput Analysis
+
+---
+
+# Report Snapshot
+
+![report\_snapshot](examples/sample-report.jpeg)
+
+---
+
+# Example Files
+
+See the `examples/` directory:
+
+```text
+examples/
+├── sample-code.py
+├── sample-report.html
+└── sample-report.jpeg
+```
+
+---
+
+# Use Cases
+
+### QA Engineers
+
+* Regression Testing
+* Smoke Testing
+* API Validation
+
+### SRE Teams
+
+* Capacity Testing
+* Reliability Benchmarking
+* SLA Validation
+
+### Developers
+
+* Endpoint Benchmarking
+* Performance Optimization
+
+### DevOps Engineers
+
+* Pre-Deployment Validation
+* Infrastructure Load Testing
+
+---
+
+# License
+
+MIT License
+
+---
+
+### Attribution
+
+<a href="https://www.flaticon.com/free-icons/hammer" title="hammer icons">Hammer icons created by nawicon - Flaticon</a>