Skip to content

Commit ba9b382

Browse files
committed
Move README.md to the root directory
1 parent f353278 commit ba9b382

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# RP Checker
2+
3+
RP Checker is a site connectivity checker utility. It takes one or more website URLs and checks if those sites are online. It can perform the connectivity checks either synchronously or asynchronously.
4+
5+
## Installation
6+
7+
1. Create a Python virtual environment
8+
9+
```sh
10+
$ python -m venv ./venv
11+
$ source venv/bin/activate
12+
(venv) $
13+
```
14+
15+
2. Install the requirements
16+
17+
```
18+
(venv) $ pip install -r requirements.txt
19+
```
20+
21+
## Run the Project
22+
23+
```sh
24+
(venv) $ python -m rpchecker -u python.org
25+
The status of "python.org" is: "Online!" 👍
26+
```
27+
28+
## Features
29+
30+
RP Checker provides the following options:
31+
32+
- `-u` or `--urls` take one or more URLs and check if they're online.
33+
- `-f` or `--input-file` take a file containing a list of URLs to check.
34+
- `-a` or `--asynchronous` run the check asynchronously.
35+
36+
## About the Author
37+
38+
Leodanis Pozo Ramos - Email: [email protected]
39+
40+
## License
41+
42+
Distributed under the MIT license. See `LICENSE` in the root directory of this `materials` repo for more information.

0 commit comments

Comments
 (0)