Merge pull request #46 from codePerfectPlus/dev

better cli output
Py-Contributors · Nov 3, 2022 · e43ee9f · e43ee9f
2 parents d10d121 + dc8693b
commit e43ee9f
Show file tree

Hide file tree

Showing 13 changed files with 57 additions and 50 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,11 +4,13 @@ All notable changes to this project will be documented in this file. The format
 
 ## Changelog
 
-## [Unreleased] 
+## [0.2.4] 
 
+- Beautiful command line output
 - Moved test files to random_profile to avoid flake8:402 error
 - Following proper changelog format, added changelog file
-- Added config for readthedocs
+- Docs: Added documentation for the project
+- Bug fixed: Fixed a bug with random_profile import
 
 ## [v0.2.3] - 13-10-2022
 

diff --git a/docs/command_line_usage.rst b/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. 
@@ -25,55 +25,62 @@ Usages:
         -j, --jobtitle  Get job title
     
 Get Random Profile:
-------------
+-------------------
 
 .. code-block:: bash
 
     # n = number of random profiles, p = profile
     random_profile -n 10 -p
 
 Get First Name:
-------------
+---------------
 
 .. code-block:: bash
 
     # n = number of random profiles, f = first name
     random_profile -n 10 -f 
 
 Get Last Name:
-------------
+--------------
 
 .. code-block:: bash
 
     # n = number of random profiles, l = last name
     random_profile -n 10 -l
 
 Get Job Title:
-------------
+--------------
 
 .. code-block:: bash
 
     # n = number of random profiles, j = job title
     random_profile -n 10 -j
 
 Get IPv4 Address:
-------------
+-----------------
 
 .. code-block:: bash
 
     # n = number of random profiles, ip = ipv4
     random_profile -n 10 -ip
 
 Get Random Profile and Save to File:
-------------
+------------------------------------
 
 .. code-block:: bash
 
     # n = number of random profiles, p = profile
     random_profile -n 10 -p > random_profiles.txt
 
+.. code-block:: bash
+
+    # save to a file
+    # n = number of random profiles, p = profile
+    random_profile -n 10 -p >> random_profiles.txt
+
+
 Get Random Profile version:
-------------
+---------------------------
 
 .. code-block:: bash
 

diff --git a/docs/import_as_module.rst b/docs/import_as_module.rst
@@ -1,5 +1,5 @@
 Import as module
-------------
+----------------
 
 You can import the module and use it in your own scripts. 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,11 +6,11 @@
 .. rst-class:: hide-header
 
 Welcome to RandomProfileGenerator's documentation!
-=====================================
+=================================================
 
-|PyPI download month|
+|Total download|
 
-.. |PyPI download month| image:: https://img.shields.io/pypi/dm/random_profile.svg
+.. |Total download| image:: http://pepy.tech/badge/random_profile
    :target: https://pypi.python.org/pypi/random_profile/
 
 |PyPI version fury.io|
@@ -41,21 +41,11 @@ 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>`_.
 
-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/
-
+Contents:
+---------
 
 .. toctree::
-   :hidden:
+   :maxdepth: 2
 
    introduction.rst
    installation.rst
@@ -65,4 +55,9 @@ Other Projects by Py-Contributors:
    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>`_
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -1,8 +1,8 @@
 Installation
-=========
+============
 
 Install Via Pip(recommended):
-------------
+----------------------------
 
 .. code-block:: bash
 
@@ -11,16 +11,17 @@ 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
 

diff --git a/docs/introduction.rst b/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,9 +18,3 @@ Use cases
 - Generating fake data for your demo
 - Generating fake data for your blog post
 
-Upcoming features
-------------
-
-- Support for more languages (Javascript)
-
-
diff --git a/docs/roadmap.rst b/docs/roadmap.rst
@@ -1,5 +1,5 @@
 Roadmap and future plans
-=========
+========================
 
 *  `more test coverage`
 *  `more supported file formats`

diff --git a/docs/run_test_cases.rst b/docs/run_test_cases.rst
@@ -1,12 +1,19 @@
 Run test cases
-=========
+==============
 
 For the test cases, we are using `pytest`. The test cases are located in the `tests` directory. To run the test cases, you can use the following command:
 
 
 .. code-block:: bash
 
-    $ pytest tests
+    pytest tests
+
+
+.. code-block:: bash
+
+    flake8 . --ignore=E501
+
+
 
 You can also run the test cases with coverage:
 
diff --git a/log/__init__.py b/log/__init__.py
diff --git a/random_profile/__main__.py → random_profile/cli.py b/random_profile/__main__.py → random_profile/cli.py
@@ -1,5 +1,6 @@
-from audiobook.main import RandomProfile
+from random_profile.main import RandomProfile
 import argparse
+from pprint import pprint
 
 
 def main():
@@ -42,17 +43,17 @@ def main():
 
     rp = RandomProfile(args.n)
     if args.fullname:
-        print(*rp.full_name(), sep="\n")
+        pprint(rp.full_name())
     elif args.profile:
-        print(*rp.full_profile(), sep="\n")
+        pprint(rp.full_profile())
     elif args.lastname:
-        print(*rp.last_name(), sep="\n")
+        pprint(rp.last_name())
     elif args.jobtitle:
-        print(*rp.job_title(), sep="\n")
+        pprint(rp.job_title())
     elif args.ipv4:
-        print(*rp.ipv4(), sep="\n")
+        pprint(rp.ipv4())
     else:
-        print('Type `random_profile -h` for help')
+        pprint('Type `random_profile -h` for help')
 
 
 if __name__ == "__main__":

diff --git a/random_profile/utils.py b/random_profile/utils.py
@@ -5,7 +5,7 @@
 
 ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 ASSETS_DIR = os.path.join(ROOT_DIR, "random_profile", "assets")
-logging.basicConfig(filename='log/example.log', encoding='utf-8', level=logging.DEBUG)
+logging.basicConfig(filename='log/example.log', level=logging.DEBUG)
 
 
 def load_txt_file(file_name: str) -> list:

diff --git a/update_package.sh → scripts/update_package.sh b/update_package.sh → scripts/update_package.sh
diff --git a/setup.py b/setup.py
@@ -25,6 +25,6 @@
         "Topic :: Utilities",
         "Environment :: Plugins"],
     entry_points={
-        "console_scripts": ["random_profile = random_profile.__main__:main"],
+        "console_scripts": ["random_profile = random_profile.cli:main"],
     },
 )