rouint 1.0.0__tar.gz

rouint-1.0.0/LICENSE

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

rouint-1.0.0/PKG-INFO

@@ -0,0 +1,289 @@
+Metadata-Version: 2.4
+Name: rouint
+Version: 1.0.0
+Summary: CLI-Based API Endpoint Management and Testing Tool
+Author-email: Kavimugil Rajasekar <kavimugil28@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/KavimugilRajasekar/Rouint
+Project-URL: Repository, https://github.com/KavimugilRajasekar/Rouint
+Project-URL: Issues, https://github.com/KavimugilRajasekar/Rouint/issues
+Keywords: api,testing,curl,cli,tui,endpoint-management
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Utilities
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click<9,>=8.1
+Requires-Dist: rich<16,>=13.0
+Requires-Dist: questionary<3,>=2.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Dynamic: license-file
+
+# Rouint
+
+A CLI-based API endpoint management and testing tool that wraps `curl`. Define endpoints once, organize them locally, and test them against any environment directly from the terminal — no GUI required.
+
+Rouint stores endpoint configurations (method, path, headers, auth, body, files) in a local `.rouint-data/` directory and executes requests through the system's `curl` installation, giving you the transparency of a raw shell command with the organization of a professional API client.
+
+## Features
+
+- Define reusable API endpoint templates with `{placeholder}` parameters
+- Interactive endpoint creation wizard with step-back navigation (Esc to go back)
+- Support for GET, POST, PUT, PATCH, DELETE, HEAD, and OPTIONS methods
+- Custom headers with method-aware defaults
+- Authentication — Bearer Token (with temp token reuse) and Custom header auth
+- JSON request body with inline validation
+- **File attachment support** — multipart/form-data via `curl -F`
+- **Multi-environment support** — add local, staging, and production URLs; choose at test time
+- Automatic URL encoding of placeholder values
+- Pretty-printed JSON in both REQUEST and RESPONSE boxes
+- Full-width terminal panels that adapt to your terminal size
+- Input validation — base URLs, JSON bodies, and file paths checked on entry
+- Local-first storage — all data stays in your project directory
+- `.gitignore` auto-generated to keep environments and tokens out of version control
+
+## Requirements
+
+- Python 3.9 or higher
+- `curl` installed and available on your `PATH`
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install rouint
+```
+
+### From source (for development)
+
+```bash
+git clone https://github.com/KavimugilRajasekar/Rouint.git
+cd Rouint
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### 1. Initialize your workspace
+
+```bash
+rouint init
+```
+
+Creates `.rouint-data/` in your current directory:
+
+```
+.rouint-data/
+├── .gitignore           # Keeps environments, tokens, and bodies out of git
+├── config.json          # Workspace configuration
+├── registry.json        # Endpoint registry (maps IDs to slugs)
+├── endpoints/           # Endpoint configuration files
+├── environments/        # Base URLs (gitignored)
+└── bodies/              # Request body files (gitignored)
+```
+
+### 2. Add your base URLs
+
+```bash
+rouint add-base-url
+```
+
+Choose **Add a new base URL**, enter the URL and a label:
+
+```
+local      → http://127.0.0.1:8080
+staging    → https://staging.myapp.com
+production → https://api.myapp.com
+```
+
+To remove a URL, choose **Delete an environment**.
+
+### 3. Create an endpoint
+
+```bash
+rouint add-new-api
+```
+
+A 7-step wizard — press **Esc** at any step to go back to the previous one:
+
+| Step | What you set |
+|------|-------------|
+| 1 | HTTP method — GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS |
+| 2 | Path — with optional `{placeholder}` syntax |
+| 3 | Headers — method-aware defaults, add/edit freely |
+| 4 | Auth — None, Bearer Token, or Custom header |
+| 5 | Body — JSON, validated on entry (POST/PUT/PATCH/DELETE) |
+| 6 | Files — multipart attachments (POST/PUT/PATCH/DELETE) |
+| 7 | Name — a memorable label |
+
+The endpoint is saved without a base URL — you choose the environment at test time.
+
+### 4. Test an endpoint
+
+```bash
+rouint start-test
+```
+
+Flow: **Select endpoint → Select base URL → Fill placeholders → Execute**
+
+Displays three panels:
+
+- **REQUEST** — method, path, headers, body (pretty-printed JSON)
+- **RESPONSE** — status, headers, body (pretty-printed JSON)
+- **METRICS** — HTTP status, response time, response size
+
+Use `--no-metrics` to hide the metrics panel:
+
+```bash
+rouint start-test --no-metrics
+```
+
+If a token is detected in the response (Bearer/JWT), Rouint offers to save it as a temp token and automatically reuses it on subsequent Bearer-auth requests.
+
+### 5. Manage your collection
+
+```bash
+rouint list-api
+```
+
+Select any endpoint to:
+- **Edit** — re-run the wizard with existing values pre-filled; Esc steps back
+- **View Configuration** — print the raw JSON
+- **Delete** — remove permanently after confirmation
+
+## Placeholder System
+
+Use `{name}` syntax anywhere in the path or query string:
+
+| Path | Placeholders | Example input |
+|------|-------------|---------------|
+| `/users/{id}` | `id` | `usr-101` |
+| `/search?q={query}` | `query` | `hello world` → URL-encoded |
+| `/users/{id}/posts/{post_id}` | `id`, `post_id` | `123`, `456` |
+
+Rules:
+- Names must match `[a-zA-Z0-9_]`
+- Names must be unique within an endpoint
+- Braces must be balanced
+- Values are URL-encoded automatically at test time
+
+## File Attachments
+
+For POST/PUT/PATCH/DELETE endpoints, you can attach files during creation:
+
+```
+File path: /home/user/photo.jpg
+Form field name: avatar
+```
+
+At test time, Rouint sends the request as `multipart/form-data` via `curl -F`. The `Content-Type` header is removed automatically — curl sets the correct boundary.
+
+## Authentication
+
+| Type | Behaviour |
+|------|-----------|
+| None | No auth header added |
+| Bearer Token | Prompts for token; offers saved temp token if available |
+| Custom | Prompts for header name and value; saved in endpoint config |
+
+**Temp token workflow:**
+1. Login endpoint returns a token → Rouint detects it
+2. "Save as temp token?" → saved to `.rouint-data/.temp_token` (chmod 0600)
+3. Next Bearer-auth request → "Use saved temp token?" → auto-filled
+4. `rouint clear-token` → removes it
+
+## Git Safety
+
+`rouint init` creates `.rouint-data/.gitignore` that protects:
+
+```gitignore
+environments/    # real base URLs
+.temp_token      # live Bearer tokens
+bodies/          # may contain credentials
+*.secret.json    # explicitly sensitive files
+```
+
+Safe to commit: `endpoints/`, `registry.json`, `config.json`
+
+## Commands Reference
+
+| Command | Description |
+|---------|-------------|
+| `rouint init` | Initialize the Rouint workspace |
+| `rouint add-base-url` | Add or delete a base URL environment |
+| `rouint add-new-api` | Define a new API endpoint interactively |
+| `rouint start-test` | Select an endpoint + base URL and run the test |
+| `rouint list-api` | List, inspect, edit, or delete saved endpoints |
+| `rouint clear-token` | Clear the saved temp Bearer token |
+
+## Workflow at a Glance
+
+```
+rouint init          # set up workspace (once per project)
+rouint add-base-url  # register: local → http://127.0.0.1:8080
+rouint add-new-api   # define: POST /api/v1/auth/login
+rouint start-test    # pick endpoint → pick URL → test!
+rouint list-api      # manage saved endpoints
+```
+
+## Project Structure
+
+```
+Rouint/
+├── pyproject.toml
+├── LICENSE
+├── README.md
+├── rouint/
+│   ├── __init__.py         # Package init, exposes __version__
+│   ├── cli.py              # Click CLI commands and interactive flows
+│   ├── core/
+│   │   ├── executor.py     # curl wrapper, file upload, URL/file validation
+│   │   ├── manager.py      # Endpoint CRUD (save, list, delete)
+│   │   └── parser.py       # Placeholder extraction, resolution, validation
+│   ├── utils/
+│   │   └── config.py       # Workspace init, data paths, .gitignore generation
+│   └── ui/
+│       └── components.py   # Banner, header, box_width
+└── tests/
+    ├── test_executor.py
+    ├── test_parser.py
+    └── test_manager.py
+```
+
+## Development
+
+```bash
+git clone https://github.com/KavimugilRajasekar/Rouint.git
+cd Rouint
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+```bash
+pytest tests/ -v        # run tests
+python -m build         # build wheel + sdist
+twine upload dist/*     # publish to PyPI
+```
+
+## License
+
+MIT License — see [LICENSE](LICENSE) for details.
+
+## Author
+
+Kavimugil Rajasekar (kavimugil28@gmail.com)

rouint-1.0.0/README.md

@@ -0,0 +1,255 @@
+# Rouint
+
+A CLI-based API endpoint management and testing tool that wraps `curl`. Define endpoints once, organize them locally, and test them against any environment directly from the terminal — no GUI required.
+
+Rouint stores endpoint configurations (method, path, headers, auth, body, files) in a local `.rouint-data/` directory and executes requests through the system's `curl` installation, giving you the transparency of a raw shell command with the organization of a professional API client.
+
+## Features
+
+- Define reusable API endpoint templates with `{placeholder}` parameters
+- Interactive endpoint creation wizard with step-back navigation (Esc to go back)
+- Support for GET, POST, PUT, PATCH, DELETE, HEAD, and OPTIONS methods
+- Custom headers with method-aware defaults
+- Authentication — Bearer Token (with temp token reuse) and Custom header auth
+- JSON request body with inline validation
+- **File attachment support** — multipart/form-data via `curl -F`
+- **Multi-environment support** — add local, staging, and production URLs; choose at test time
+- Automatic URL encoding of placeholder values
+- Pretty-printed JSON in both REQUEST and RESPONSE boxes
+- Full-width terminal panels that adapt to your terminal size
+- Input validation — base URLs, JSON bodies, and file paths checked on entry
+- Local-first storage — all data stays in your project directory
+- `.gitignore` auto-generated to keep environments and tokens out of version control
+
+## Requirements
+
+- Python 3.9 or higher
+- `curl` installed and available on your `PATH`
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install rouint
+```
+
+### From source (for development)
+
+```bash
+git clone https://github.com/KavimugilRajasekar/Rouint.git
+cd Rouint
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### 1. Initialize your workspace
+
+```bash
+rouint init
+```
+
+Creates `.rouint-data/` in your current directory:
+
+```
+.rouint-data/
+├── .gitignore           # Keeps environments, tokens, and bodies out of git
+├── config.json          # Workspace configuration
+├── registry.json        # Endpoint registry (maps IDs to slugs)
+├── endpoints/           # Endpoint configuration files
+├── environments/        # Base URLs (gitignored)
+└── bodies/              # Request body files (gitignored)
+```
+
+### 2. Add your base URLs
+
+```bash
+rouint add-base-url
+```
+
+Choose **Add a new base URL**, enter the URL and a label:
+
+```
+local      → http://127.0.0.1:8080
+staging    → https://staging.myapp.com
+production → https://api.myapp.com
+```
+
+To remove a URL, choose **Delete an environment**.
+
+### 3. Create an endpoint
+
+```bash
+rouint add-new-api
+```
+
+A 7-step wizard — press **Esc** at any step to go back to the previous one:
+
+| Step | What you set |
+|------|-------------|
+| 1 | HTTP method — GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS |
+| 2 | Path — with optional `{placeholder}` syntax |
+| 3 | Headers — method-aware defaults, add/edit freely |
+| 4 | Auth — None, Bearer Token, or Custom header |
+| 5 | Body — JSON, validated on entry (POST/PUT/PATCH/DELETE) |
+| 6 | Files — multipart attachments (POST/PUT/PATCH/DELETE) |
+| 7 | Name — a memorable label |
+
+The endpoint is saved without a base URL — you choose the environment at test time.
+
+### 4. Test an endpoint
+
+```bash
+rouint start-test
+```
+
+Flow: **Select endpoint → Select base URL → Fill placeholders → Execute**
+
+Displays three panels:
+
+- **REQUEST** — method, path, headers, body (pretty-printed JSON)
+- **RESPONSE** — status, headers, body (pretty-printed JSON)
+- **METRICS** — HTTP status, response time, response size
+
+Use `--no-metrics` to hide the metrics panel:
+
+```bash
+rouint start-test --no-metrics
+```
+
+If a token is detected in the response (Bearer/JWT), Rouint offers to save it as a temp token and automatically reuses it on subsequent Bearer-auth requests.
+
+### 5. Manage your collection
+
+```bash
+rouint list-api
+```
+
+Select any endpoint to:
+- **Edit** — re-run the wizard with existing values pre-filled; Esc steps back
+- **View Configuration** — print the raw JSON
+- **Delete** — remove permanently after confirmation
+
+## Placeholder System
+
+Use `{name}` syntax anywhere in the path or query string:
+
+| Path | Placeholders | Example input |
+|------|-------------|---------------|
+| `/users/{id}` | `id` | `usr-101` |
+| `/search?q={query}` | `query` | `hello world` → URL-encoded |
+| `/users/{id}/posts/{post_id}` | `id`, `post_id` | `123`, `456` |
+
+Rules:
+- Names must match `[a-zA-Z0-9_]`
+- Names must be unique within an endpoint
+- Braces must be balanced
+- Values are URL-encoded automatically at test time
+
+## File Attachments
+
+For POST/PUT/PATCH/DELETE endpoints, you can attach files during creation:
+
+```
+File path: /home/user/photo.jpg
+Form field name: avatar
+```
+
+At test time, Rouint sends the request as `multipart/form-data` via `curl -F`. The `Content-Type` header is removed automatically — curl sets the correct boundary.
+
+## Authentication
+
+| Type | Behaviour |
+|------|-----------|
+| None | No auth header added |
+| Bearer Token | Prompts for token; offers saved temp token if available |
+| Custom | Prompts for header name and value; saved in endpoint config |
+
+**Temp token workflow:**
+1. Login endpoint returns a token → Rouint detects it
+2. "Save as temp token?" → saved to `.rouint-data/.temp_token` (chmod 0600)
+3. Next Bearer-auth request → "Use saved temp token?" → auto-filled
+4. `rouint clear-token` → removes it
+
+## Git Safety
+
+`rouint init` creates `.rouint-data/.gitignore` that protects:
+
+```gitignore
+environments/    # real base URLs
+.temp_token      # live Bearer tokens
+bodies/          # may contain credentials
+*.secret.json    # explicitly sensitive files
+```
+
+Safe to commit: `endpoints/`, `registry.json`, `config.json`
+
+## Commands Reference
+
+| Command | Description |
+|---------|-------------|
+| `rouint init` | Initialize the Rouint workspace |
+| `rouint add-base-url` | Add or delete a base URL environment |
+| `rouint add-new-api` | Define a new API endpoint interactively |
+| `rouint start-test` | Select an endpoint + base URL and run the test |
+| `rouint list-api` | List, inspect, edit, or delete saved endpoints |
+| `rouint clear-token` | Clear the saved temp Bearer token |
+
+## Workflow at a Glance
+
+```
+rouint init          # set up workspace (once per project)
+rouint add-base-url  # register: local → http://127.0.0.1:8080
+rouint add-new-api   # define: POST /api/v1/auth/login
+rouint start-test    # pick endpoint → pick URL → test!
+rouint list-api      # manage saved endpoints
+```
+
+## Project Structure
+
+```
+Rouint/
+├── pyproject.toml
+├── LICENSE
+├── README.md
+├── rouint/
+│   ├── __init__.py         # Package init, exposes __version__
+│   ├── cli.py              # Click CLI commands and interactive flows
+│   ├── core/
+│   │   ├── executor.py     # curl wrapper, file upload, URL/file validation
+│   │   ├── manager.py      # Endpoint CRUD (save, list, delete)
+│   │   └── parser.py       # Placeholder extraction, resolution, validation
+│   ├── utils/
+│   │   └── config.py       # Workspace init, data paths, .gitignore generation
+│   └── ui/
+│       └── components.py   # Banner, header, box_width
+└── tests/
+    ├── test_executor.py
+    ├── test_parser.py
+    └── test_manager.py
+```
+
+## Development
+
+```bash
+git clone https://github.com/KavimugilRajasekar/Rouint.git
+cd Rouint
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+```bash
+pytest tests/ -v        # run tests
+python -m build         # build wheel + sdist
+twine upload dist/*     # publish to PyPI
+```
+
+## License
+
+MIT License — see [LICENSE](LICENSE) for details.
+
+## Author
+
+Kavimugil Rajasekar (kavimugil28@gmail.com)

rouint-1.0.0/pyproject.toml

@@ -0,0 +1,53 @@
+[project]
+name = "rouint"
+version = "1.0.0"
+description = "CLI-Based API Endpoint Management and Testing Tool"
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [
+    {name = "Kavimugil Rajasekar", email = "kavimugil28@gmail.com"}
+]
+license = "MIT"
+keywords = ["api", "testing", "curl", "cli", "tui", "endpoint-management"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Topic :: Utilities",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Testing",
+]
+dependencies = [
+    "click>=8.1,<9",
+    "rich>=13.0,<16",
+    "questionary>=2.0,<3",
+]
+
+[project.urls]
+Homepage = "https://github.com/KavimugilRajasekar/Rouint"
+Repository = "https://github.com/KavimugilRajasekar/Rouint"
+Issues = "https://github.com/KavimugilRajasekar/Rouint/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "build>=1.0",
+]
+
+[project.scripts]
+rouint = "rouint.cli:cli"
+
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["rouint*"]

rouint-1.0.0/rouint/__init__.py

@@ -0,0 +1,3 @@
+"""Rouint — CLI-Based API Endpoint Management and Testing Tool."""
+
+__version__ = "1.0.0"