Merge branch 'main' into dev

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

Author: codeperfectplus

CHANGELOG.md

@@ -26,6 +26,7 @@ All notable changes to this project will be documented in this file. The format
 
 - [x] Updating API Documentation
 - [x] Bug fixes
+- [x] Get Gender Specific Data
 
 ## [V3.0.1] - Minor Release - 18-11-2022
 

CONTRIBUTING.md

@@ -50,6 +50,12 @@ We love your input! We want to make contributing to this project as easy and tra
 
 - Create a PR from our repo on Github.
 
+### Run Flake8
+
+```sh
+flake8 . --isolated  --ignore=E501,E402
+```
+
 ### Additional Notes
 
 - Any changes should be made in the `dev` branch.

docs/assets/sample.png

@@ -61,6 +61,7 @@ Other Projects by Py-Contributors:
    installation.rst
    command_line_usage.rst
    import_as_module.rst
+   run_as_server.rst
    changelog.rst
    roadmap.rst
    run_test_cases.rst

docs/index.rst

@@ -11,7 +11,7 @@ Use cases
 - Mocking classes
 - Populating databases
 - Generating test data
-- Generating fake data for your application
+- Generating fake data for Cybersecurity
 - Generating fake data for your tests
 - Generating fake data for your documentation
 - Generating fake data for your presentation

docs/introduction.rst

@@ -0,0 +1,30 @@
+Run as server
+=============
+
+To run as a server, you need to specify the port to listen on:
+
+
+.. code-block:: bash
+
+    default port is 8000
+    $ rp --server --port 8080
+
+This will start a server on port 8080. You can then use the client to connect to it:
+
+Test it with postman
+
+.. code-block:: bash
+
+    $ curl -X GET http://localhost:8080/ -H 'Content-Type: application/json'
+
+Interactive Api Documentation
+
+`http://localhost:<port>/docs`
+
+API Endpoints
+-------------
+
+`localhost:8000/api/v1/random_profile/full_profile?num=10`
+`localhost:8000/api/v1/random_profile/first_name?num=10`
+`localhost:8000/api/v1/random_profile/last_name?num=10`
+`localhost:8000/api/v1/random_profile/full_name?num=10`

docs/run_as_server.rst

@@ -1,3 +1,3 @@
 fastapi
 uvicorn
-pytest
+pytest

requirements.txt

@@ -0,0 +1,113 @@
+import unittest
+import sys
+
+sys.path.append('.')
+from typing import List, Tuple
+from random_profile import RandomProfile
+random_profile = RandomProfile(num=1)
+
+
+class RandomProfileTest(unittest.TestCase):
+    # ----------------------------------------------------------------- #
+    def test_fname_instance(self):
+        self.assertIsInstance(random_profile.first_name(), str)
+
+    def test_faname_with_num(self):
+        self.assertEqual(len(RandomProfile(num=10).first_name()), 10)
+
+    def test_fname_with_num_instance(self):
+        self.assertIsInstance(RandomProfile(num=10).first_name(), List)
+
+    # ----------------------------------------------------------------- #
+    def test_lname_instance(self):
+        self.assertIsInstance(random_profile.last_name(), str)
+
+    def test_lname_with_num(self):
+        self.assertEqual(len(RandomProfile(num=10).last_name()), 10)
+
+    def test_lname_with_num_instance(self):
+        self.assertIsInstance(RandomProfile(num=10).last_name(), List)
+
+    # ----------------------------------------------------------------- #
+    def test_full_name_instance(self):
+        self.assertIsInstance(random_profile.full_name(), str)
+
+    def test_full_name_with_num(self):
+        self.assertEqual(len(RandomProfile(num=10).full_name()), 10)
+
+    def test_full_name_with_num_instance(self):
+        self.assertIsInstance(RandomProfile(num=10).full_name(), List)
+
+    # ----------------------------------------------------------------- #
+    def test_full_profile_instance(self):
+        self.assertIsInstance(random_profile.full_profile(), List)
+
+    def test_full_profile_with_num(self):
+        self.assertEqual(len(RandomProfile(num=10).full_profile()), 10)
+
+    def test_full_profile_with_num_instance(self):
+        self.assertIsInstance(RandomProfile(num=10).full_profile(), List)
+
+    # ----------------------------------------------------------------- #
+    def test_ipv4_instance(self):
+        self.assertIsInstance(random_profile.ip_address(), str)
+
+    def test_ipv4_with_num(self):
+        self.assertEqual(len(RandomProfile(num=10).ip_address()), 10)
+
+    def test_ipv4_with_num_instance(self):
+        self.assertIsInstance(RandomProfile(num=10).ip_address(), List)
+
+    # ----------------------------------------------------------------- #
+    def test_job_title_instance(self):
+        self.assertIsInstance(random_profile.job_title(), str)
+
+    def test_job_title_with_num(self):
+        self.assertEqual(len(RandomProfile(num=10).job_title()), 10)
+
+    def test_job_title_with_num_instance(self):
+        self.assertIsInstance(RandomProfile(num=10).job_title(), List)
+
+    # ----------------------------------------------------------------- #
+    def test_blood_type_instance(self):
+        self.assertIsInstance(random_profile.blood_type(), str)
+
+    def test_blood_type_with_num(self):
+        self.assertEqual(len(RandomProfile(num=10).blood_type()), 10)
+
+    def test_blood_type_with_num_instance(self):
+        self.assertIsInstance(RandomProfile(num=10).blood_type(), List)
+
+    # ----------------------------------------------------------------- #
+    def test_hair_color_instance(self):
+        self.assertIsInstance(random_profile.hair_color(), str)
+
+    def test_hair_color_with_num(self):
+        self.assertEqual(len(RandomProfile(num=10).hair_color()), 10)
+
+    def test_hair_color_with_num_instance(self):
+        self.assertIsInstance(RandomProfile(num=10).hair_color(), List)
+
+    # ----------------------------------------------------------------- #
+    def test_dob_age_instance(self):
+        self.assertIsInstance(random_profile.dob_age(), Tuple)
+
+    def test_dob_age_with_num(self):
+        self.assertEqual(len(RandomProfile(num=10).dob_age()), 10)
+
+    def test_dob_age_with_num_instance(self):
+        self.assertIsInstance(RandomProfile(num=10).dob_age(), List)
+
+    # ----------------------------------------------------------------- #
+    def test_address_instance(self):
+        self.assertIsInstance(random_profile.generate_address(), List)
+
+    def test_address_with_num(self):
+        self.assertEqual(len(RandomProfile(num=10).generate_address()), 10)
+
+    def test_address_with_num_instance(self):
+        self.assertIsInstance(RandomProfile(num=10).generate_address(), List)
+
+
+if __name__ == "__main__":
+    unittest.main()