Merge branch 'dev' | V3.0.2 released

Author: codeperfectplus

CHANGELOG.md

@@ -4,7 +4,16 @@ All notable changes to this project will be documented in this file. The format
 
 ## Changelog
 
-## [V3.0.0] - Major Release
+## [V3.0.2] - Minor Release - 
+
+- [x] Updating API Documentation
+- [x] Get Gender Specific Data 
+
+## [V3.0.1] - Minor Release - 18-11-2022
+
+- [x] Code refactor for better readability
+- [x] Link updated for pypi website 
+## [V3.0.0] - Major Release - 09-11-2022
 
 - [x] Function names changed
 - [x] Gender can be passed as a parameter

CONTRIBUTING.md

@@ -15,7 +15,7 @@ We love your input! We want to make contributing to this project as easy and tra
 ### Making a PR
 
 > - Make sure you have been assigned the issue to which you are making a PR.
-> - If you make PR before being assigned, It may be labeled `invalid` and closed without merging.
+> - If you make PR before being assigned, It may be labelled `invalid` and closed without merging.
 
 - Fork the repo and clone it on your machine.
 - Add a upstream link to main branch in your cloned repo
@@ -27,7 +27,7 @@ We love your input! We want to make contributing to this project as easy and tra
 - Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
 
     ```sh
-    git pull upstream master
+    git pull upstream dev
     ```
 
 - Create your feature branch

README.md

@@ -1,10 +1,13 @@
+<p align="center">
+  <a href="https://py-contributors.github.io/audiobook/"><img src="https://capsule-render.vercel.app/api?type=rect&color=009ACD&height=100&section=header&text=RandomProfileGenerator3.0.1&fontSize=40%&fontColor=fffff" alt="website title image"></a>
+  <h2 align="center">👉 Python Module To Generate Random Profile Data 👈</h2>
+</p>
 
-<h1 align="center">
-  <a href="https://pypi.org/project/random-profile/">
-  Random Profile Generator
-</h1>
-
-<h4 align="center">Python Module To Generate Random Profile Data</h4>
+<p align="center">
+    <a href="https://twitter.com/pycontributors"><img src="https://img.shields.io/twitter/follow/pycontributors?style=social" alt="Twitter" /></a>
+    <a href="https://github.com/codeperfectplus?tab=followers"><img src="https://img.shields.io/github/followers/codeperfectplus.svg?style=social&label=Follow&maxAge=2592000"/></a>
+</p>
+</br>
 
 <p align="center">
 <img src="https://img.shields.io/pypi/v/random-profile.svg">

docs/command_line_usage.rst

@@ -80,3 +80,18 @@ Get Random Profile version:
     random_profile --version
 
     random-profile 0.2.3
+
+
+Get Only Gender Specific Profiles:
+------------
+
+To get gender specific profiles, use the `-ma` or `-fe` flags.
+
+.. code-block:: bash
+
+    # n = number of random profiles, p = profile -ma male
+    random_profile -n 10 -p -ma
+
+    # n = number of random profiles, p = profile -fe female
+    random_profile -n 10 -p -fe
+

docs/conf.py

@@ -1,10 +1,22 @@
-from datetime import datetime
+import sys
+sys.path.append('.')
 
+from datetime import datetime
 
-project = 'Random Profile Generator'
-description = 'A random profile generator for testing purposes.'
-author = 'Deeapk Raj'
-release = '1.0.1'
+__title__ = 'RandomProfileGenerator'
+__package_name__ = 'random_profile'
+__version__ = '3.0.2'
+__description__ = "Python Module To Generate Random Profile Data"
+__email__ = "[email protected]"
+__author__ = 'Deepak Raj'
+__github__ = 'https://github.com/Py-Contributors/RandomProfileGenerator'
+__pypi__ = 'https://pypi.org/project/random-profile/'
+__license__ = 'MIT License'
+
+project = __package_name__
+description = __description__
+author = __author__
+release = __version__
 year = datetime.now().year
 copyright = "{} Deepak Raj".format(year)
 source_suffix = ".rst"
@@ -21,17 +33,11 @@
 
 autosectionlabel_prefix_document = True
 
-html_theme = 'sphinx_rtd_theme'  # 'pydata_sphinx_theme' 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv']
 html_sidebars = {'**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']}
 
-rst_epilog = """
-.. |project| replace:: Random Profile Generator
-.. |copyright| replace:: Copyright © {} Deepak Raj
-.. | community | replace:: `Py-Contributors <https://github.com/py-contributors/>`_
-""".format(year)
-
 # epub settings
 epub_basename = project
 epub_theme = 'epub'

random_profile/__about__.py

@@ -0,0 +1,9 @@
+__title__ = 'RandomProfileGenerator'
+__package_name__ = 'random_profile'
+__version__ = '3.0.2'
+__description__ = "Python Module To Generate Random Profile Data"
+__email__ = "[email protected]"
+__author__ = 'Deepak Raj'
+__github__ = 'https://github.com/Py-Contributors/RandomProfileGenerator'
+__pypi__ = 'https://pypi.org/project/random-profile/'
+__license__ = 'MIT License'

random_profile/__init__.py

@@ -1,3 +1,3 @@
-from random_profile.main import RandomProfile
+from random_profile.main import RandomProfile, __version__
 
-__all__ = ["RandomProfile"]
+__all__ = [RandomProfile, __version__]

random_profile/api.py

@@ -5,7 +5,8 @@
 from pydantic import create_model
 
 sys.path.append('.')
-from random_profile.main import RandomProfile, VERSION
+from random_profile.main import RandomProfile
+from random_profile.__about__ import __version__
 
 # random_profile==0.2.3 required
 rp = RandomProfile()
@@ -17,7 +18,7 @@
 metadata = {
     "status": "200",
     "message": "Success",
-    "version": VERSION,
+    "version": __version__,
     "author": "Deepak Raj",
     "author_email": "[email protected]",
     "github": "https://github.com/codeperfectplus"}
@@ -28,7 +29,8 @@
 
 
 @app.get("/")
-def index():
+def home():
+    """ just a home page """
     return metadata
 
 
@@ -156,7 +158,7 @@ def custom_openapi():
         return app.openapi_schema
     openapi_schema = get_openapi(
         title="Random Profile Generator API",
-        version=VERSION,
+        version=__version__,
         description="Python Module To Generate Random Profile Data",
         routes=app.routes,
     )

random_profile/cli.py

@@ -7,12 +7,12 @@
 sys.path.append('.')
 
 from random_profile.main import RandomProfile
-from random_profile.main import VERSION
+from random_profile.__about__ import __version__
 from random_profile.api import start_server
-from enums.gender import Gender
+from random_profile.enums.gender import Gender
 
 parser = argparse.ArgumentParser()
-parser.add_argument('-v', '--version', action='version', version=VERSION)
+parser.add_argument('-v', '--version', action='version', version=__version__)
 parser.add_argument('--repeat', help='Repeat the output', action='store_true')
 parser.add_argument('--server', help='Start server', action='store_true')
 parser.add_argument('--port', help='Port number', type=int, default=8000)

random_profile/enums/gender.py

@@ -1,7 +1,7 @@
 from enum import Enum
 
 
-# class syntax
 class Gender(Enum):
+    """ Gender Enum Class """
     MALE = "Male"
     FEMALE = "Female"