# IsItDownRightNow
This is a simple Python wrapper for the IsItDownRightNow API, allowing users to check in real-time whether a specific website is currently accessible worldwide.
## Installation
```bash
pip install isitdownrightnow
```
## Usage
```py
from isitdownrightnow import IsItDownRightNow
# Create an instance for a website
checker = IsItDownRightNow('google.com')
# Get the status of the website
status = checker.status
print(status)
```
```py
{
'up': True,
'website_name': 'Google',
'url_checked': 'www.google.com',
'response_time_ms': 16.73,
'last_down': 'More than a week ago',
'down_for': None,
'status': 'UP',
'message': 'Google.com is UP and reachable by us.'
}
```
## Simple Overview
The main class in the wrapper is IsItDownRightNow. Here's a brief overview of its methods and properties:
**Public Methods and Properties:**
* **status:** Returns a dictionary containing the status of the website.
**Attributes:**
* **domain:** The domain name of the site to be checked.
___
**Returns**
For the status method, you can expect a dictionary with the following structure:
* **up** (bool): True if the domain is up, False otherwise.
* **website_name** (str): The name of the website.
* **url_checked** (str): The URL that was checked.
* **response_time** (str): The response time of the website.
* **last_down** (str): The last time the website was down (None if the website is down).
* **down_for** (str): The duration of time the website has been down (None if the website is up).
* **status** (str): The status of the website, either "UP" or "DOWN".
* **message** (str): A message about the result of the check.
Raw data
{
"_id": null,
"home_page": "https://github.com/ccan23/isitdownrightnow",
"name": "isitdownrightnow",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,uptime,server,website,down,ping",
"author": "ccan23",
"author_email": "dev.ccanb@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/3a/ca/c59950475bd18a78e12db05065619de4d4f7930260c227a7a9a88b0d2ef2/isitdownrightnow-0.0.1.tar.gz",
"platform": null,
"description": "# IsItDownRightNow\n\nThis is a simple Python wrapper for the IsItDownRightNow API, allowing users to check in real-time whether a specific website is currently accessible worldwide.\n\n## Installation\n```bash\npip install isitdownrightnow\n```\n\n## Usage\n```py\nfrom isitdownrightnow import IsItDownRightNow\n\n# Create an instance for a website\nchecker = IsItDownRightNow('google.com')\n\n# Get the status of the website\nstatus = checker.status\nprint(status)\n```\n\n```py\n{\n 'up': True, \n 'website_name': 'Google', \n 'url_checked': 'www.google.com',\n 'response_time_ms': 16.73,\n 'last_down': 'More than a week ago', \n 'down_for': None, \n 'status': 'UP', \n 'message': 'Google.com is UP and reachable by us.'\n}\n```\n\n## Simple Overview\n\nThe main class in the wrapper is IsItDownRightNow. Here's a brief overview of its methods and properties:\n\n**Public Methods and Properties:**\n* **status:** Returns a dictionary containing the status of the website.\n\n**Attributes:**\n* **domain:** The domain name of the site to be checked.\n\n___\n\n**Returns**\n\nFor the status method, you can expect a dictionary with the following structure:\n\n* **up** (bool): True if the domain is up, False otherwise.\n\n* **website_name** (str): The name of the website.\n\n* **url_checked** (str): The URL that was checked.\n\n* **response_time** (str): The response time of the website.\n\n* **last_down** (str): The last time the website was down (None if the website is down).\n\n* **down_for** (str): The duration of time the website has been down (None if the website is up).\n\n* **status** (str): The status of the website, either \"UP\" or \"DOWN\".\n\n* **message** (str): A message about the result of the check.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A straightforward wrapper for the IsItDownRightNow API.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/ccan23/isitdownrightnow"
},
"split_keywords": [
"python",
"uptime",
"server",
"website",
"down",
"ping"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "595c2919fd897f7b10217863dac1fd529a6ebf4f9618100cecf693024bb1d5da",
"md5": "b3f9f5340eb91f08e55c67e0518e09a5",
"sha256": "bb074a742be16a6089f16ebf5b7610c36ada13d2da62d59736cb2321544c88f8"
},
"downloads": -1,
"filename": "isitdownrightnow-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3f9f5340eb91f08e55c67e0518e09a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5256,
"upload_time": "2023-10-25T21:33:02",
"upload_time_iso_8601": "2023-10-25T21:33:02.497751Z",
"url": "https://files.pythonhosted.org/packages/59/5c/2919fd897f7b10217863dac1fd529a6ebf4f9618100cecf693024bb1d5da/isitdownrightnow-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3acac59950475bd18a78e12db05065619de4d4f7930260c227a7a9a88b0d2ef2",
"md5": "8ec923f0d644351268a21d2def079762",
"sha256": "bcad1b3bd0d1b121d9dcfe063f377667649ae3dbca4d0fb109fafeca9216f3bb"
},
"downloads": -1,
"filename": "isitdownrightnow-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8ec923f0d644351268a21d2def079762",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4766,
"upload_time": "2023-10-25T21:33:04",
"upload_time_iso_8601": "2023-10-25T21:33:04.277914Z",
"url": "https://files.pythonhosted.org/packages/3a/ca/c59950475bd18a78e12db05065619de4d4f7930260c227a7a9a88b0d2ef2/isitdownrightnow-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 21:33:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ccan23",
"github_project": "isitdownrightnow",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "isitdownrightnow"
}
JSON
