Skip to content

Commit 8938845

Browse files
Updating README for command line tool
1 parent 0942a5c commit 8938845

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ conda install random-profile # using anaconda
3131

3232
## Documentation
3333

34+
### As Python Module
35+
3436
```python
3537
from random_profile import RandomProfile
3638
rp = RandomProfile(num=5)
@@ -39,7 +41,6 @@ rp = RandomProfile(num=5)
3941
num = Total No. of Name You Want To Print
4042
default is 1
4143
change the num value according to your needs.
42-
4344
'''
4445
# num can be overwritten in the function
4546

@@ -56,9 +57,32 @@ rp.full_profile(num=10)
5657
rp.last_name(num=6)
5758
```
5859

59-
## Usage
60+
### As Command Line Tool
61+
62+
```bash
63+
$ random-profile --help
64+
Usage: random-profile [OPTIONS]
65+
66+
usage: random_profile [-h] [-n N] [-f | -p | -l | -ip | -j]
67+
68+
optional arguments:
69+
-h, --help show this help message and exit
70+
-n N Number of random profiles
71+
-f, --fullname Get full name instead of first name
72+
-p, --profile Get full profile instead of first name
73+
-l, --lastname Get last name instead of first name
74+
-ip, --ipv4 Get an ipv4 IP address
75+
-j, --jobtitle Get job title
76+
```
77+
78+
```bash
79+
$ random-profile -n 10 -f # to get 10 full names
80+
$ random-profile -n 10 -p # to get 10 full profiles
81+
$ random-profile -n 10 -l # to get 10 last names
82+
$ random-profile -n 10 -ip # to get 10 ipv4 addresses
83+
$ random-profile -n 10 -j # to get 10 job titles
84+
```
6085

61-
the random-profile module is a random profile generator for many usages like: ex- fake dataset, YouTube videos, content creation, personal projects.
6286

6387
## Support
6488

0 commit comments

Comments
 (0)