Skip to content

Commit

Permalink
Merge pull request #430 from MortezaBashsiz/py-progressbar
Browse files Browse the repository at this point in the history
added rich to the requirements in readme
  • Loading branch information
MortezaBashsiz authored Apr 13, 2023
2 parents 85eb755 + 5020acf commit 3774b9e
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ CFSCanner runs on different operating systems including and not limited to:
* Libraries
- requests
- pysocks
- rich

# Installing

Expand Down Expand Up @@ -112,13 +113,14 @@ In the following, you can find examples of running the script with and without c
python3 cfscanner.py --threads 8 --config ./myconfig.json --subnets ./mysubnets.selection --download-speed 100 --upload-speed 25 --tries 3
```
* 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

```bash
python3 cfscanner.py -t 8 -DS 10 -US 10 -r 20
```
```

---

## <a name="anchor-args"></a>Arguments
## `<a name="anchor-args"></a>`Arguments

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

Expand All @@ -134,10 +136,10 @@ To see the help message, use the `--help` or `-h` option.
subnet in cidr notation (v4 or v6). If not provided, the program will
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).
* `--sample`, `-r`: Size of the random sample to take from each subnet. The sample size can either
be a float between 0 and 1 ($0 < s < 1$) or an integer ($ s \ge 1$). If it is a float, it will be
interpreted as a percentage of the subnet size. If it is an integer, it
will be interpreted as the number of ips to take from each subnet. If
not provided, the program will take all ips from each subnet
be a float between 0 and 1 ($0 < s < 1$) or an integer ($ s \ge 1$). If it is a float, it will be
interpreted as a percentage of the subnet size. If it is an integer, it
will be interpreted as the number of ips to take from each subnet. If
not provided, the program will take all ips from each subnet

#### Xray Config Options

Expand Down Expand Up @@ -210,7 +212,7 @@ Contributors names and contact info
* Fixed a bug in the min UL speed, especially for ``min_upload_speed = 0``
* 1.0.3
* Fixed a bug in custom config template
* 1.1.0
* 1.1.0
* Added random sampling
* 1.2.0
* Added progress bar
Expand Down

0 comments on commit 3774b9e

Please sign in to comment.