# GHOSTPIP
**GHOSTPIP** is a Python module that provides convenient methods for interacting with the `ghost.toxinum.xyz` API. It enables you to perform various operations such as user signup, signin, retrieving user information, fetching location details, getting SIM information, device details, balance information, and more.
## Installation
You can install **GHOSTPIP** using pip:
```shell
pip install ghostpip
```
## Usage
```python
from ghostpip import (
signup,
signin,
get_user,
get_location,
get_sim_info,
get_device_info,
get_account_balance,
submit_birth_information,
submit_nid_information,
simulate_talk,
teach_chatbot
)
```
### Function Examples
Here are some examples of how to use the functions:
#### Signup a new user:
```python
signup("John Doe", "johndoe@example.com", "password123")
```
#### Signin with an existing user:
```python
signin("johndoe@example.com", "password123")
```
#### Get user information:
```python
get_user("your-api-key")
```
#### Get location details:
```python
get_location("your-api-key", "0123456789")
```
#### Get SIM information:
```python
get_sim_info("your-api-key", "0123456789")
```
#### Get device information:
```python
get_device_info("your-api-key", "0123456789")
```
#### Get account balance:
```python
get_account_balance("your-api-key", "0123456789")
```
#### Submit birth information:
```python
submit_birth_information("your-api-key", "birth-info", "dob")
```
#### Submit NID information:
```python
submit_nid_information("your-api-key", "nid-info", "dob")
```
#### Simulate talk:
```python
simulate_talk("your-api-key", "ask", "lc")
```
#### Teach chatbot:
```python
teach_chatbot("your-api-key", "ask", "ans", "lc")
```
## API Documentation
For detailed information on the API endpoints and parameters, please refer to the [ghost.toxinum.xyz API documentation](https://ghost.toxinum.xyz/docs.html).
## Contributing
Contributions to **GHOSTPIP** are welcome! If you find any issues or have suggestions for improvement, please create an issue or submit a pull request on the GitHub repository.
## Contact
- Facebook: [Mohammad Alamin](https://www.facebook.com/Illusionghost?mibextid=ZbWKwL)
- Telegram: [XYRUS INC](https://t.me/xyrusinc)
- GitHub: [@illusionghost3](https://github.com/illusionghost3)
### Thanks For Starππ¨βπ»
[![Stargazers repo](https://reporoster.com/stars/illusionghost3/ghostpip)](https://github.com/illusionghost3/ghostpip/stargazers)
### Thanks For Fork ππ¨βπ»
[![Forkers repo](https://reporoster.com/forks/illusionghost3/ghostpip)](https://github.com/illusionghost3/ghostpip/network/members)
## License
This project is licensed under the [MIT License](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/illusionghost3/ghostpip",
"name": "ghostpip",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ghostpip api module",
"author": "Mohammad Alamin",
"author_email": "akxvau@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5a/cf/d160284dfa2617ca9f1e6e3641b40ae16c968e68c08734a1c200fe64bbb3/ghostpip-1.1.1.tar.gz",
"platform": null,
"description": "# GHOSTPIP\n\n**GHOSTPIP** is a Python module that provides convenient methods for interacting with the `ghost.toxinum.xyz` API. It enables you to perform various operations such as user signup, signin, retrieving user information, fetching location details, getting SIM information, device details, balance information, and more.\n\n## Installation\n\nYou can install **GHOSTPIP** using pip:\n\n```shell\npip install ghostpip\n```\n\n## Usage\n\n```python\nfrom ghostpip import (\n signup,\n signin,\n get_user,\n get_location,\n get_sim_info,\n get_device_info,\n get_account_balance,\n submit_birth_information,\n submit_nid_information,\n simulate_talk,\n teach_chatbot\n)\n```\n\n### Function Examples\n\nHere are some examples of how to use the functions:\n\n#### Signup a new user:\n\n```python\nsignup(\"John Doe\", \"johndoe@example.com\", \"password123\")\n```\n\n#### Signin with an existing user:\n\n```python\nsignin(\"johndoe@example.com\", \"password123\")\n```\n\n#### Get user information:\n\n```python\nget_user(\"your-api-key\")\n```\n\n#### Get location details:\n\n```python\nget_location(\"your-api-key\", \"0123456789\")\n```\n\n#### Get SIM information:\n\n```python\nget_sim_info(\"your-api-key\", \"0123456789\")\n```\n\n#### Get device information:\n\n```python\nget_device_info(\"your-api-key\", \"0123456789\")\n```\n\n#### Get account balance:\n\n```python\nget_account_balance(\"your-api-key\", \"0123456789\")\n```\n\n#### Submit birth information:\n\n```python\nsubmit_birth_information(\"your-api-key\", \"birth-info\", \"dob\")\n```\n\n#### Submit NID information:\n\n```python\nsubmit_nid_information(\"your-api-key\", \"nid-info\", \"dob\")\n```\n\n#### Simulate talk:\n\n```python\nsimulate_talk(\"your-api-key\", \"ask\", \"lc\")\n```\n\n#### Teach chatbot:\n\n```python\nteach_chatbot(\"your-api-key\", \"ask\", \"ans\", \"lc\")\n```\n\n\n## API Documentation\n\nFor detailed information on the API endpoints and parameters, please refer to the [ghost.toxinum.xyz API documentation](https://ghost.toxinum.xyz/docs.html).\n\n## Contributing\n\nContributions to **GHOSTPIP** are welcome! If you find any issues or have suggestions for improvement, please create an issue or submit a pull request on the GitHub repository.\n\n## Contact\n\n- Facebook: [Mohammad Alamin](https://www.facebook.com/Illusionghost?mibextid=ZbWKwL)\n- Telegram: [XYRUS INC](https://t.me/xyrusinc)\n- GitHub: [@illusionghost3](https://github.com/illusionghost3)\n\n### Thanks For Star\ud83d\ude4f\ud83d\udc68\u200d\ud83d\udcbb\n\n[![Stargazers repo](https://reporoster.com/stars/illusionghost3/ghostpip)](https://github.com/illusionghost3/ghostpip/stargazers)\n\n### Thanks For Fork \ud83d\ude4f\ud83d\udc68\u200d\ud83d\udcbb\n\n[![Forkers repo](https://reporoster.com/forks/illusionghost3/ghostpip)](https://github.com/illusionghost3/ghostpip/network/members)\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python module for interacting with the ghost.toxinum.xyz API",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/illusionghost3/ghostpip"
},
"split_keywords": [
"ghostpip",
"api",
"module"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5acfd160284dfa2617ca9f1e6e3641b40ae16c968e68c08734a1c200fe64bbb3",
"md5": "b63b1aa52ea3d77648a20c85c847703c",
"sha256": "a557cf6b70a3bae1cc9d013edd21882e1d0021a40fdc8d4191338c025fbdb41e"
},
"downloads": -1,
"filename": "ghostpip-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b63b1aa52ea3d77648a20c85c847703c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5545,
"upload_time": "2023-06-15T05:10:45",
"upload_time_iso_8601": "2023-06-15T05:10:45.606926Z",
"url": "https://files.pythonhosted.org/packages/5a/cf/d160284dfa2617ca9f1e6e3641b40ae16c968e68c08734a1c200fe64bbb3/ghostpip-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-15 05:10:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "illusionghost3",
"github_project": "ghostpip",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ghostpip"
}