Skip to content

Commit abc6f8e

Browse files
codeperfectplusDrakeEntityDavidCano98
authored
Bumping version 3.0.0 (#54)
* better cli output * updating documentation * updating documentation * updating badge * updating changelog * Update publish.yml * updating setup.py * Update README.md * first stable release Signed-off-by: Deepak Raj <54245038+codePerfectPlus@users.noreply.github.com> * Update CHANGELOG.md * updating cli * refactoring code Signed-off-by: Deepak Raj <54245038+codePerfectPlus@users.noreply.github.com> * fixing flake8 error * bug fixed Signed-off-by: Deepak Raj <54245038+codePerfectPlus@users.noreply.github.com> * tested * flake8 error * flake8 error * refactroing code * updating docs Signed-off-by: Deepak Raj <54245038+codePerfectPlus@users.noreply.github.com> * test cases updated * test cases updated * adding scripts for release automation (#49) * bumping version 1.0.0 to 2.0.0 (#50) * adding scripts for release automation * v2.0.0 releasing * updating changelog Signed-off-by: Deepak Raj <54245038+codePerfectPlus@users.noreply.github.com> * Delete update_package.sh * Update FUNDING.yml * Update FUNDING.yml * Issue #44 (#52) * add gender options for first names * add gender options for first names, random card * add job experience according to years of age * add parameter option for logging (not implemented yet) * add handpicked locations to cities in list * add float coords generation * add coordinates string formatting * fix ages in job level generation * start of unit tests * add more tests * add assertregex ussage in tests * fix missing imports * lint fixes * two lines padding before class * solving git conflict * refactoring code Signed-off-by: Deepak Raj <54245038+codePerfectPlus@users.noreply.github.com> * refacoting code and changelog update * Update FUNDING.yml Signed-off-by: Deepak Raj <54245038+codePerfectPlus@users.noreply.github.com> Co-authored-by: Rahul Sharma <53327705+DrakeEntity@users.noreply.github.com> Co-authored-by: DavidCano98 <63115730+DavidCano98@users.noreply.github.com>
1 parent 620d18f commit abc6f8e

25 files changed

Lines changed: 1583 additions & 302 deletions

.github/FUNDING.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
custom: ["https://www.buymeacoffee.com/codeperfectplus"]
1+
github: [codeperfectplus]
2+
3+
4+
5+

.github/workflows/add_labels.yaml

Lines changed: 0 additions & 17 deletions
This file was deleted.

.github/workflows/publish.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.

.github/workflows/python-app.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ jobs:
1414
python -m pip install --upgrade pip
1515
pip install flake8
1616
- name: Lint with flake8
17-
run: flake8 . --isolated --exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox,**/migrations/** --ignore=E501,E402
17+
run: flake8 . --isolated --exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox,**/migrations/** --ignore=E402,E501,E401

CHANGELOG.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,26 @@ All notable changes to this project will be documented in this file. The format
44

55
## Changelog
66

7-
## [2.0.0] - 07-11-2022
7+
## [V3.0.0] - Major Release
8+
9+
- [x] Function names changed
10+
- [x] Gender can be passed as a parameter
11+
- [x] Credit/Debit information will be generate
12+
- [x]
13+
14+
## [v2.0.0] Major Release - 07-11-2022
815

916
- server can be start from cli
1017
- More Endpoints exposed to the API/CLI
1118
- Code refactored
1219

20+
## [V1.0.0] Major Release - 05-11-2022
1321

14-
## [1.0.0] - 05-11-2022
15-
16-
- Beautiful command line output
17-
- Moved test files to random_profile to avoid flake8:402 error
18-
- Following proper changelog format, added changelog file
19-
- Docs: Added documentation for the project
20-
- Bug fixed: Fixed a bug with random_profile import
22+
Beautiful command line output
23+
Moved test files to random_profile to avoid flake8:402 error
24+
Following proper changelog format, added changelog file
25+
Docs: Added documentation for the project
26+
Bug fixed: Fixed a bug with random_profile import
2127

2228
## [v0.2.3] - 13-10-2022
2329

README.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
<h1 align="center">
33
<a href="https://pypi.org/project/random-profile/">
44
Random Profile Generator
5-
</a>
6-
V2.0.0
75
</h1>
86

97
<h4 align="center">Python Module To Generate Random Profile Data</h4>
@@ -19,34 +17,27 @@
1917
<img src="https://img.shields.io/pypi/dw/random-profile.svg">
2018
<img src="https://img.shields.io/pypi/dm/random-profile.svg">
2119
</p>
22-
<p align="center">
20+
<p align="center">
2321

2422
<img alt="GitHub pull-requests" src="https://img.shields.io/github/issues-pr/Py-Contributors/RandomProfileGenerator">
2523

26-
<img alt="GitHub forks" src="https://img.shields.io/github/forks/Py-Contributors/RandomProfileGenerator">
24+
<img alt="GitHub forks" src="https://img.shields.io/github/forks/Py-Contributors/RandomProfileGenerator">
2725

28-
<img alt="contributors" src="https://img.shields.io/github/contributors/Py-Contributors/RandomProfileGenerator">
26+
<img alt="contributors" src="https://img.shields.io/github/contributors/Py-Contributors/RandomProfileGenerator">
2927

3028
<img alt="GitHub stars" src="https://img.shields.io/github/stars/Py-Contributors/RandomProfileGenerator"> </p>
3129

3230

3331
[RandomProfile](https://pypi.org/project/random-profile/) is a powerful and simple tool to generate fake data. You can use it to mock classes, populate databases and much more. You can check the full documentation here. Check on [Pypi](https://pypi.org/project/random-profile/)
3432

35-
```sh
36-
pip install random-profile
37-
```
3833

3934
## Documentation
4035

41-
Full Documentation is available at [ReadTheDocs](https://randomprofilegenerator.readthedocs.io/en/latest/)
36+
Documentation is available at [ReadTheDocs](https://randomprofilegenerator.readthedocs.io/en/latest/)
4237

4338
## Upcoming Features
4439

45-
- More Data Fields
46-
- More Data Types
47-
- Make it more user friendly and easy to use
48-
- Make it more efficient and faster
49-
- Cython Support
40+
- Support for more languages
5041

5142
## Changelog
5243

@@ -58,14 +49,10 @@ Check the [Contributing](/CONTRIBUTING.md) for the contribution guidelines.
5849

5950
## License
6051

61-
The project is licensed under the <a href="/LICENSE">MIT</a> license.
52+
The project is licensed under the <a href="/LICENSE">MIT</a> license.
6253

6354
## Contributors
6455

6556
<a href="https://github.com/codePerfectPlus/awesomeScripts/graphs/contributors">
6657
<img src="https://contrib.rocks/image?repo=codePerfectPlus/randomprofilegenerator" />
6758
</a>
68-
69-
## Sponsor
70-
71-
Email: [Pycontributors](mailto:deepak008@live.com) for sponsorship details.

docs/command_line_usage.rst

Lines changed: 28 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Command line usages
2-
===================
2+
=========
33

44
`Random Profile Generator` can be used as a command line tool.
55
It can be used to generate a random profile and save it to a file.
@@ -9,87 +9,74 @@ Usages:
99

1010
.. code-block:: bash
1111
12-
rp --help or random_profile -h
13-
Usage: rp [OPTIONS]
12+
random-profile --help
13+
Usage: random-profile [OPTIONS]
1414
15-
rp -n 10 -p
15+
random-profile -n 10 -p
1616
1717
optional arguments:
18-
-h, --help show this help message and exit
19-
-v, --version show program's version number and exit
20-
--server Start server
21-
--port PORT Port number
22-
-n N Number of random profiles
23-
-p, --profile Get full profile
24-
-f, --firstname Get first name
25-
-l, --lastname Get last name instead of first name
26-
--fullname Get full name instead of first name
27-
--ip Get an ipv4 IP address
28-
--job Get job title
29-
--address Get address
30-
18+
-h, --help show this help message and exit
19+
-n N Number of random profiles
20+
21+
-f, --fullname Get full name instead of first name
22+
-p, --profile Get full profile instead of first name
23+
-l, --lastname Get last name instead of first name
24+
-ip, --ipv4 Get an ipv4 IP address
25+
-j, --jobtitle Get job title
26+
3127
Get Random Profile:
32-
-------------------
28+
------------
3329

3430
.. code-block:: bash
3531
3632
# n = number of random profiles, p = profile
37-
rp -n 10 -p
33+
random_profile -n 10 -p
3834
3935
Get First Name:
40-
---------------
36+
------------
4137

4238
.. code-block:: bash
4339
4440
# n = number of random profiles, f = first name
45-
rp -n 10 -f
41+
random_profile -n 10 -f
4642
4743
Get Last Name:
48-
--------------
44+
------------
4945

5046
.. code-block:: bash
5147
5248
# n = number of random profiles, l = last name
53-
rp -n 10 -l
49+
random_profile -n 10 -l
5450
5551
Get Job Title:
56-
--------------
52+
------------
5753

5854
.. code-block:: bash
5955
6056
# n = number of random profiles, j = job title
61-
rp -n 10 -j
57+
random_profile -n 10 -j
6258
6359
Get IPv4 Address:
64-
-----------------
60+
------------
6561

6662
.. code-block:: bash
6763
6864
# n = number of random profiles, ip = ipv4
69-
rp -n 10 -ip
70-
65+
random_profile -n 10 -ip
7166
7267
Get Random Profile and Save to File:
73-
------------------------------------
74-
75-
.. code-block:: bash
76-
77-
# n = number of random profiles, p = profile
78-
rp -n 10 -p > rps.txt
68+
------------
7969

8070
.. code-block:: bash
8171
82-
# save to a file
8372
# n = number of random profiles, p = profile
84-
rp -n 10 -p >> rps.txt
85-
73+
random_profile -n 10 -p > random_profiles.txt
8674
8775
Get Random Profile version:
88-
---------------------------
76+
------------
8977

9078
.. code-block:: bash
9179
92-
rp --version
93-
94-
rp 0.2.3
80+
random_profile --version
9581
82+
random-profile 0.2.3

docs/import_as_module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Import as module
2-
----------------
2+
------------
33

44
You can import the module and use it in your own scripts.
55

docs/index.rst

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
.. rst-class:: hide-header
77

88
Welcome to RandomProfileGenerator's documentation!
9-
=================================================
9+
=====================================
1010

11-
|Total download|
11+
|PyPI download month|
1212

13-
.. |Total download| image:: http://pepy.tech/badge/random_profile
13+
.. |PyPI download month| image:: https://img.shields.io/pypi/dm/random_profile.svg
1414
:target: https://pypi.python.org/pypi/random_profile/
1515

1616
|PyPI version fury.io|
@@ -41,11 +41,21 @@ If you love open source contributions.
4141
* Join the community on `Discord <https://discord.gg/JfbK3bS>`_.
4242
* join the community on `Github <https://github.com/Py-Contributors/support/issues/new?assignees=&labels=invite+me+to+the+organisation&template=invite.yaml&title=Please+invite+me+to+the+GitHub+Community+Organization>`_.
4343

44-
Contents:
45-
---------
44+
Other Projects by Py-Contributors:
45+
--------------
46+
47+
* `AudioBook <https://audiobook.readthedocs.io/en/latest//>`_
48+
* `Cybel - The Discord Bot <https://github.com/Py-Contributors/Cybel>`_
49+
* `Twitterify - Tweet-retweet bot <https://github.com/Py-Contributors/twitterify>`_
50+
51+
|forthebadge made-with-python|
52+
53+
.. |forthebadge made-with-python| image:: http://ForTheBadge.com/images/badges/made-with-python.svg
54+
:target: https://www.python.org/
55+
4656

4757
.. toctree::
48-
:maxdepth: 2
58+
:hidden:
4959

5060
introduction.rst
5161
installation.rst
@@ -56,9 +66,4 @@ Contents:
5666
roadmap.rst
5767
run_test_cases.rst
5868

59-
Other Projects by Py-Contributors:
60-
---------------------------------
6169

62-
* `AudioBook <https://audiobook.readthedocs.io/en/latest//>`_
63-
* `Cybel - The Discord Bot <https://github.com/Py-Contributors/Cybel>`_
64-
* `Twitterify - Tweet-retweet bot <https://github.com/Py-Contributors/twitterify>`_

docs/installation.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Installation
2-
============
2+
=========
33

44
Install Via Pip(recommended):
5-
----------------------------
5+
------------
66

77
.. code-block:: bash
88
@@ -11,17 +11,16 @@ Install Via Pip(recommended):
1111
1212
1313
Install from Source(Unreleased):
14-
--------------------------------
14+
------------
1515

1616
.. code-block:: bash
1717
1818
git clone https://github.com/Py-Contributors/RandomProfileGenerator
19-
git checkout main
2019
cd RandomProfileGenerator
2120
python setup.py install
2221
2322
Test Installation:
24-
-----------------
23+
------------
2524

2625
.. code-block:: bash
2726

0 commit comments

Comments
 (0)