@@ -31,6 +31,8 @@ conda install random-profile # using anaconda
31
31
32
32
## Documentation
33
33
34
+ ### As Python Module
35
+
34
36
``` python
35
37
from random_profile import RandomProfile
36
38
rp = RandomProfile(num = 5 )
@@ -39,7 +41,6 @@ rp = RandomProfile(num=5)
39
41
num = Total No. of Name You Want To Print
40
42
default is 1
41
43
change the num value according to your needs.
42
-
43
44
'''
44
45
# num can be overwritten in the function
45
46
@@ -56,9 +57,32 @@ rp.full_profile(num=10)
56
57
rp.last_name(num = 6 )
57
58
```
58
59
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
+ ```
60
85
61
- the random-profile module is a random profile generator for many usages like: ex- fake dataset, YouTube videos, content creation, personal projects.
62
86
63
87
## Support
64
88
0 commit comments