refactoring codebase

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

Author: codeperfectplus

api/api.py

@@ -1,10 +1,14 @@
+import sys
+sys.path.append('.')
+
+from random_profile.__about__ import *
 from datetime import datetime
 
 
-project = 'Random Profile Generator'
-description = 'A random profile generator for testing purposes.'
-author = 'Deeapk Raj'
-release = '0.2.3'
+project = __package_name__
+description = __description__
+author = __author__
+release = __version__
 year = datetime.now().year
 copyright = "{} Deepak Raj".format(year)
 source_suffix = ".rst"
@@ -21,17 +25,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'

api/requirements.txt

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

docs/conf.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 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"}
@@ -156,7 +157,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/__about__.py

@@ -15,8 +15,7 @@
 
 from random_profile.enums.gender import Gender
 from random_profile import utils
-
-VERSION = '3.0.1'
+from random_profile.__about__ import __version__
 
 lname_txt = os.path.join(utils.ASSETS_DIR, "lnames.txt")
 fname_male_txt = os.path.join(utils.ASSETS_DIR, "fnames_male.txt")
@@ -69,7 +68,7 @@ def __init__(self, num: int = 1, gender: Gender = None):
         self.gender = gender
 
     def __str__(self) -> str:
-        return f'Random Profile Generator version {VERSION}'
+        return f'Random Profile Generator version {__version__}'
 
     def __repr__(self) -> str:
         return f'RandomProfile(num={self.num})'

random_profile/api.py

@@ -1,23 +1,25 @@
 import setuptools
 from glob import glob
 
+from random_profile.__about__ import *
+
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
 with open("requirements.txt", "r") as fh:
     requirements = fh.read().splitlines()
 
 setuptools.setup(
-    name="random_profile",
-    version="3.0.1",
-    author="Deepak Raj",
-    author_email="[email protected]",
-    description="Generate Random Profile",
+    name=__package_name__,
+    version=__version__,
+    author=__author__,
+    author_email=__email__,
+    description=__description__,
     long_description=long_description,
     long_description_content_type="text/markdown",
     install_requires=requirements,
     data_files=[('assets', glob('random_profile/assets/*'))],
-    url="https://github.com/Py-Contributors/RandomProfileGenerator",
+    url=__github__,
     packages=setuptools.find_packages(),
     project_urls={"Documentation": "https://pycontributors.readthedocs.io/projects/randomprofilegenerator/en/latest/",
                   "Source": "https://github.com/Py-Contributors/RandomProfileGenerator",