Skip to content

Commit 3774b9e

Browse files
Merge pull request #430 from MortezaBashsiz/py-progressbar
added rich to the requirements in readme
2 parents 85eb755 + 5020acf commit 3774b9e

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

python/README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ CFSCanner runs on different operating systems including and not limited to:
1818
* Libraries
1919
- requests
2020
- pysocks
21+
- rich
2122

2223
# Installing
2324

@@ -112,13 +113,14 @@ In the following, you can find examples of running the script with and without c
112113
python3 cfscanner.py --threads 8 --config ./myconfig.json --subnets ./mysubnets.selection --download-speed 100 --upload-speed 25 --tries 3
113114
```
114115
* To run on a random sample of size 20 of the subnets and minimum acceptable download and upload speed of 10 KBps with the default config
116+
115117
```bash
116118
python3 cfscanner.py -t 8 -DS 10 -US 10 -r 20
117-
```
119+
```
118120

119121
---
120122

121-
## <a name="anchor-args"></a>Arguments
123+
## `<a name="anchor-args"></a>`Arguments
122124

123125
To use this tool, you can specify various options as follows:
124126

@@ -134,10 +136,10 @@ To see the help message, use the `--help` or `-h` option.
134136
subnet in cidr notation (v4 or v6). If not provided, the program will
135137
read the list of cidrs from [https://github.com/MortezaBashsiz/CFScanner/blob/main/bash/cf.local.iplist](https://github.com/MortezaBashsiz/CFScanner/blob/main/bash/cf.local.iplist).
136138
* `--sample`, `-r`: Size of the random sample to take from each subnet. The sample size can either
137-
be a float between 0 and 1 ($0 < s < 1$) or an integer ($ s \ge 1$). If it is a float, it will be
138-
interpreted as a percentage of the subnet size. If it is an integer, it
139-
will be interpreted as the number of ips to take from each subnet. If
140-
not provided, the program will take all ips from each subnet
139+
be a float between 0 and 1 ($0 < s < 1$) or an integer ($ s \ge 1$). If it is a float, it will be
140+
interpreted as a percentage of the subnet size. If it is an integer, it
141+
will be interpreted as the number of ips to take from each subnet. If
142+
not provided, the program will take all ips from each subnet
141143

142144
#### Xray Config Options
143145

@@ -210,7 +212,7 @@ Contributors names and contact info
210212
* Fixed a bug in the min UL speed, especially for ``min_upload_speed = 0``
211213
* 1.0.3
212214
* Fixed a bug in custom config template
213-
* 1.1.0
215+
* 1.1.0
214216
* Added random sampling
215217
* 1.2.0
216218
* Added progress bar

0 commit comments

Comments
 (0)