# RESTX
[](https://github.com/fullstack-spiderman/restx/actions/workflows/ci.yml)
## Description
A Python CLI application for sending HTTP requests using different methods (GET, POST, PUT, PATCH, DELETE).
### Installation
#### Using pip
```bash
pip install restx
```
#### Or using poetry
```bash
poetry add restx
```
#### Usage
##### HTTP GET (All Records)
```bash
restx get <url_with_endpoint>
# Example: restx get https://jsonplaceholder.typicode.com/posts/
```
##### HTTP GET (Read Single Record)
```bash
restx get <url_with_endpoint>
# Example: restx get https://jsonplaceholder.typicode.com/posts/54
```
##### HTTP POST (Create a Record)
```bash
restx post <url_with_endpoint> --payload '<json payload>'
# Example: restx post "https://jsonplaceholder.typicode.com/posts" --payload '{"userId": 12, "title": "test doc body"}'
```
##### HTTP PUT (Update a Record)
```bash
restx put <url_with_endpoint> --payload '<json payload>'
# Example: restx put "https://jsonplaceholder.typicode.com/posts" --payload '{"userId": 12, "title": "test doc body"}'
```
##### HTTP PATCH (Partial Update a Record)
```bash
restx patch <url_with_endpoint> --payload '<json payload>'
# Example: restx patch "https://jsonplaceholder.typicode.com/posts" --payload '{"title": "test doc body"}'
```
##### HTTP DELETE (Delete a Record)
```bash
restx delete <url_with_endpoint> --payload '<json payload>'
# Example: restx delete "https://jsonplaceholder.typicode.com/posts/23"
```
##### To provide custom Headers
```bash
restx <command> <url> --header '<json header>'
# Example:
# restx post https://jsonplaceholder.typicode.com/posts --payload '{"userId": 1, "id": 1, "title": "sunt aut facere, "body": "recusandae consequuntur expedita et"}' --header '{"Content-Type": "application/json"}'
```
##### For help
```bash
restx --help
restx <get|post|put|patch|delete> --help
```
#### Contributions
Contributions are welcome! Please follow these guidelines:
- Submit bug reports or feature requests through the issue tracker.
- Set up a development environment by cloning the repository and installing dependencies.
#### License
This project is licensed under the MIT. See the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/restx/",
"name": "restx",
"maintainer": "Arjun Umathanu",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "restx, http, client, api, rest",
"author": "Arjun Umathanu",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/4a/bc/a03d0de48f7150da377bac9b8dfea40aacb8ea5b33cbab2df131ace4c4f2/restx-0.1.14.tar.gz",
"platform": null,
"description": "# RESTX\n\n[](https://github.com/fullstack-spiderman/restx/actions/workflows/ci.yml)\n\n## Description\n\nA Python CLI application for sending HTTP requests using different methods (GET, POST, PUT, PATCH, DELETE).\n\n### Installation\n\n#### Using pip\n\n```bash\npip install restx\n```\n\n#### Or using poetry\n\n```bash\npoetry add restx\n```\n\n#### Usage\n\n##### HTTP GET (All Records)\n\n```bash\nrestx get <url_with_endpoint>\n# Example: restx get https://jsonplaceholder.typicode.com/posts/\n```\n\n##### HTTP GET (Read Single Record)\n\n```bash\nrestx get <url_with_endpoint>\n# Example: restx get https://jsonplaceholder.typicode.com/posts/54\n```\n\n##### HTTP POST (Create a Record)\n\n```bash\nrestx post <url_with_endpoint> --payload '<json payload>'\n# Example: restx post \"https://jsonplaceholder.typicode.com/posts\" --payload '{\"userId\": 12, \"title\": \"test doc body\"}'\n```\n\n##### HTTP PUT (Update a Record)\n\n```bash\nrestx put <url_with_endpoint> --payload '<json payload>'\n# Example: restx put \"https://jsonplaceholder.typicode.com/posts\" --payload '{\"userId\": 12, \"title\": \"test doc body\"}'\n```\n\n##### HTTP PATCH (Partial Update a Record)\n\n```bash\nrestx patch <url_with_endpoint> --payload '<json payload>'\n# Example: restx patch \"https://jsonplaceholder.typicode.com/posts\" --payload '{\"title\": \"test doc body\"}'\n```\n\n##### HTTP DELETE (Delete a Record)\n\n```bash\nrestx delete <url_with_endpoint> --payload '<json payload>'\n# Example: restx delete \"https://jsonplaceholder.typicode.com/posts/23\"\n```\n\n##### To provide custom Headers\n\n```bash\nrestx <command> <url> --header '<json header>'\n# Example:\n# restx post https://jsonplaceholder.typicode.com/posts --payload '{\"userId\": 1, \"id\": 1, \"title\": \"sunt aut facere, \"body\": \"recusandae consequuntur expedita et\"}' --header '{\"Content-Type\": \"application/json\"}'\n```\n\n##### For help\n\n```bash\nrestx --help\nrestx <get|post|put|patch|delete> --help\n```\n\n#### Contributions\n\nContributions are welcome! Please follow these guidelines:\n\n- Submit bug reports or feature requests through the issue tracker.\n- Set up a development environment by cloning the repository and installing dependencies.\n\n#### License\n\nThis project is licensed under the MIT. See the LICENSE file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI app for performing REST API CRUD operations via HTTP/HTTPS requests.",
"version": "0.1.14",
"project_urls": {
"Documentation": "https://www.linkedin.com/pulse/introducing-restx-your-ultimate-cli-tool-http-arjun-umathanu-ugrrc/",
"Homepage": "https://pypi.org/project/restx/",
"Repository": "https://github.com/fullstack-spiderman/restx"
},
"split_keywords": [
"restx",
" http",
" client",
" api",
" rest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a6b3ef0664992211a9aa6fed53cf4dc77545d72011d7a392c3f8b19acab6880f",
"md5": "9a54312b08341f826915d6057c5ed223",
"sha256": "69a5176342b52780da61ecee3bb23822b5477e06f40f7abed58cbc29ed2f570e"
},
"downloads": -1,
"filename": "restx-0.1.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a54312b08341f826915d6057c5ed223",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 6040,
"upload_time": "2024-04-15T09:49:41",
"upload_time_iso_8601": "2024-04-15T09:49:41.473291Z",
"url": "https://files.pythonhosted.org/packages/a6/b3/ef0664992211a9aa6fed53cf4dc77545d72011d7a392c3f8b19acab6880f/restx-0.1.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4abca03d0de48f7150da377bac9b8dfea40aacb8ea5b33cbab2df131ace4c4f2",
"md5": "ee657d7a50583681e49e71b3e908be76",
"sha256": "235cde1a3aff6104cee07995bd095c7474b052db393ab83cb08120793b7ad5f6"
},
"downloads": -1,
"filename": "restx-0.1.14.tar.gz",
"has_sig": false,
"md5_digest": "ee657d7a50583681e49e71b3e908be76",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 4337,
"upload_time": "2024-04-15T09:49:43",
"upload_time_iso_8601": "2024-04-15T09:49:43.250430Z",
"url": "https://files.pythonhosted.org/packages/4a/bc/a03d0de48f7150da377bac9b8dfea40aacb8ea5b33cbab2df131ace4c4f2/restx-0.1.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 09:49:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fullstack-spiderman",
"github_project": "restx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "restx"
}
JSON
