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 <[email protected]>

* Update CHANGELOG.md

* updating cli

* refactoring code

Signed-off-by: Deepak Raj <[email protected]>

* fixing flake8 error

* bug fixed

Signed-off-by: Deepak Raj <[email protected]>

* tested

* flake8 error

* flake8 error

* refactroing code

* updating docs

Signed-off-by: Deepak Raj <[email protected]>

* 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 <[email protected]>

* 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 <[email protected]>

* refacoting code and changelog update

* Update FUNDING.yml

Signed-off-by: Deepak Raj <[email protected]>
Co-authored-by: Rahul Sharma <[email protected]>
Co-authored-by: DavidCano98 <[email protected]>

.github/FUNDING.yml

@@ -1 +1,5 @@
-custom: ["https://www.buymeacoffee.com/codeperfectplus"]
+github: [codeperfectplus]
+
+
+
+

.github/workflows/python-app.yml

@@ -14,4 +14,4 @@ jobs:
           python -m pip install --upgrade pip
           pip install flake8
       - name: Lint with flake8
-        run: flake8 . --isolated --exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox,**/migrations/** --ignore=E501,E402
+        run: flake8 . --isolated --exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox,**/migrations/** --ignore=E402,E501,E401

CHANGELOG.md

@@ -4,20 +4,26 @@ All notable changes to this project will be documented in this file. The format
 
 ## Changelog
 
-## [2.0.0] - 07-11-2022
+## [V3.0.0] - Major Release
+
+- [x] Function names changed
+- [x] Gender can be passed as a parameter
+- [x] Credit/Debit information will be generate
+- [x]    
+
+## [v2.0.0] Major Release - 07-11-2022
 
 - server can be start from cli
 - More Endpoints exposed to the API/CLI
 - Code refactored
 
+## [V1.0.0] Major Release - 05-11-2022
 
-## [1.0.0] - 05-11-2022
-
-- Beautiful command line output
-- Moved test files to random_profile to avoid flake8:402 error
-- Following proper changelog format, added changelog file
-- Docs: Added documentation for the project
-- Bug fixed: Fixed a bug with random_profile import
+Beautiful command line output
+Moved test files to random_profile to avoid flake8:402 error
+Following proper changelog format, added changelog file
+Docs: Added documentation for the project
+Bug fixed: Fixed a bug with random_profile import
 
 ## [v0.2.3] - 13-10-2022
 

README.md

@@ -2,8 +2,6 @@
 <h1 align="center">
   <a href="https://pypi.org/project/random-profile/">
   Random Profile Generator
-  </a>
-  V2.0.0
 </h1>
 
 <h4 align="center">Python Module To Generate Random Profile Data</h4>
@@ -19,34 +17,27 @@
 <img src="https://img.shields.io/pypi/dw/random-profile.svg">
 <img src="https://img.shields.io/pypi/dm/random-profile.svg">
 </p>
-<p align="center">
+<p align="center"> 
 
 <img alt="GitHub pull-requests" src="https://img.shields.io/github/issues-pr/Py-Contributors/RandomProfileGenerator">
 
-<img alt="GitHub forks" src="https://img.shields.io/github/forks/Py-Contributors/RandomProfileGenerator">
+<img alt="GitHub forks" src="https://img.shields.io/github/forks/Py-Contributors/RandomProfileGenerator"> 
 
-<img alt="contributors" src="https://img.shields.io/github/contributors/Py-Contributors/RandomProfileGenerator">
+<img alt="contributors" src="https://img.shields.io/github/contributors/Py-Contributors/RandomProfileGenerator"> 
 
 <img alt="GitHub stars" src="https://img.shields.io/github/stars/Py-Contributors/RandomProfileGenerator"> </p>
 
 
 [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/)
 
-```sh
-pip install random-profile
-```
 
 ## Documentation
 
-Full Documentation is available at [ReadTheDocs](https://randomprofilegenerator.readthedocs.io/en/latest/)
+Documentation is available at [ReadTheDocs](https://randomprofilegenerator.readthedocs.io/en/latest/)
 
 ## Upcoming Features
 
-- More Data Fields
-- More Data Types
-- Make it more user friendly and easy to use
-- Make it more efficient and faster
-- Cython Support
+- Support for more languages
 
 ## Changelog
 
@@ -58,14 +49,10 @@ Check the [Contributing](/CONTRIBUTING.md) for the contribution guidelines.
 
 ## License
 
-The project is licensed under the <a href="/LICENSE">MIT</a> license.
+The project is licensed under the <a href="/LICENSE">MIT</a> license. 
 
 ## Contributors
 
 <a href="https://github.com/codePerfectPlus/awesomeScripts/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=codePerfectPlus/randomprofilegenerator" />
 </a>
-
-## Sponsor 
-
-Email: [Pycontributors](mailto:[email protected]) for sponsorship details.

docs/command_line_usage.rst

@@ -1,5 +1,5 @@
 Command line usages
-===================
+=========
 
 `Random Profile Generator` can be used as a command line tool. 
 It can be used to generate a random profile and save it to a file. 
@@ -9,87 +9,74 @@ Usages:
 
 .. code-block:: bash
 
-    rp --help or random_profile -h
-    Usage: rp [OPTIONS]
+    random-profile --help
+    Usage: random-profile [OPTIONS]
 
-    rp -n 10 -p
+    random-profile -n 10 -p
 
     optional arguments:
-        -h, --help       show this help message and exit
-        -v, --version    show program's version number and exit
-        --server         Start server
-        --port PORT      Port number
-        -n N             Number of random profiles
-        -p, --profile    Get full profile
-        -f, --firstname  Get first name
-        -l, --lastname   Get last name instead of first name
-        --fullname       Get full name instead of first name
-        --ip             Get an ipv4 IP address
-        --job            Get job title
-        --address        Get address
-
+        -h, --help      show this help message and exit
+        -n N            Number of random profiles
+    
+        -f, --fullname  Get full name instead of first name
+        -p, --profile   Get full profile instead of first name
+        -l, --lastname  Get last name instead of first name
+        -ip, --ipv4     Get an ipv4 IP address
+        -j, --jobtitle  Get job title
+    
 Get Random Profile:
--------------------
+------------
 
 .. code-block:: bash
 
     # n = number of random profiles, p = profile
-    rp -n 10 -p
+    random_profile -n 10 -p
 
 Get First Name:
----------------
+------------
 
 .. code-block:: bash
 
     # n = number of random profiles, f = first name
-    rp -n 10 -f 
+    random_profile -n 10 -f 
 
 Get Last Name:
---------------
+------------
 
 .. code-block:: bash
 
     # n = number of random profiles, l = last name
-    rp -n 10 -l
+    random_profile -n 10 -l
 
 Get Job Title:
---------------
+------------
 
 .. code-block:: bash
 
     # n = number of random profiles, j = job title
-    rp -n 10 -j
+    random_profile -n 10 -j
 
 Get IPv4 Address:
------------------
+------------
 
 .. code-block:: bash
 
     # n = number of random profiles, ip = ipv4
-    rp -n 10 -ip
-
+    random_profile -n 10 -ip
 
 Get Random Profile and Save to File:
-------------------------------------
-
-.. code-block:: bash
-
-    # n = number of random profiles, p = profile
-    rp -n 10 -p > rps.txt
+------------
 
 .. code-block:: bash
 
-    # save to a file
     # n = number of random profiles, p = profile
-    rp -n 10 -p >> rps.txt
-
+    random_profile -n 10 -p > random_profiles.txt
 
 Get Random Profile version:
----------------------------
+------------
 
 .. code-block:: bash
 
-    rp --version
-
-    rp 0.2.3
+    random_profile --version
 
+    random-profile 0.2.3

docs/import_as_module.rst

@@ -1,5 +1,5 @@
 Import as module
-----------------
+------------
 
 You can import the module and use it in your own scripts. 
 

docs/index.rst

@@ -6,11 +6,11 @@
 .. rst-class:: hide-header
 
 Welcome to RandomProfileGenerator's documentation!
-=================================================
+=====================================
 
-|Total download|
+|PyPI download month|
 
-.. |Total download| image:: http://pepy.tech/badge/random_profile
+.. |PyPI download month| image:: https://img.shields.io/pypi/dm/random_profile.svg
    :target: https://pypi.python.org/pypi/random_profile/
 
 |PyPI version fury.io|
@@ -41,11 +41,21 @@ If you love open source contributions.
 * Join the community on `Discord <https://discord.gg/JfbK3bS>`_.
 * 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>`_.
 
-Contents:
----------
+Other Projects by Py-Contributors:
+--------------
+
+* `AudioBook <https://audiobook.readthedocs.io/en/latest//>`_
+* `Cybel - The Discord Bot <https://github.com/Py-Contributors/Cybel>`_
+* `Twitterify - Tweet-retweet bot <https://github.com/Py-Contributors/twitterify>`_
+
+|forthebadge made-with-python|
+
+.. |forthebadge made-with-python| image:: http://ForTheBadge.com/images/badges/made-with-python.svg
+   :target: https://www.python.org/
+
 
 .. toctree::
-   :maxdepth: 2
+   :hidden:
 
    introduction.rst
    installation.rst
@@ -56,9 +66,4 @@ Contents:
    roadmap.rst
    run_test_cases.rst
 
-Other Projects by Py-Contributors:
----------------------------------
 
-* `AudioBook <https://audiobook.readthedocs.io/en/latest//>`_
-* `Cybel - The Discord Bot <https://github.com/Py-Contributors/Cybel>`_
-* `Twitterify - Tweet-retweet bot <https://github.com/Py-Contributors/twitterify>`_

docs/installation.rst

@@ -1,8 +1,8 @@
 Installation
-============
+=========
 
 Install Via Pip(recommended):
-----------------------------
+------------
 
 .. code-block:: bash
 
@@ -11,17 +11,16 @@ Install Via Pip(recommended):
 
 
 Install from Source(Unreleased):
---------------------------------
+------------
 
 .. code-block:: bash
 
     git clone https://github.com/Py-Contributors/RandomProfileGenerator
-    git checkout main
     cd RandomProfileGenerator
     python setup.py install
 
 Test Installation:
------------------
+------------
 
 .. code-block:: bash
 

docs/introduction.rst

@@ -1,5 +1,5 @@
 Introduction
-============
+=========
 
 `RandomProfileGenerator` is a powerful and simple tool to generate fake data. 
 You can use it to mock classes, populate databases and much more. 
@@ -18,3 +18,9 @@ Use cases
 - Generating fake data for your demo
 - Generating fake data for your blog post
 
+Upcoming features
+------------
+
+- Support for more languages (Javascript)
+
+

docs/roadmap.rst

@@ -1,5 +1,5 @@
 Roadmap and future plans
-========================
+=========
 
 *  `more test coverage`
 *  `more supported file formats`