Merge pull request #35 from codePerfectPlus/type-check

Updated the fastapi and docs

CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Changelog
+
+## [Unreleased] 
+
+- Moved test files to random_profile to avoid flake8:402 error
+- Following proper changelog format, added changelog file
+- Added config for readthedocs
+
+## [v0.2.3] - 13-10-2022
+
+- Flask app added
+- Date of Birth Added
+- Age added
+- Height and Weight Added
+- Blood Group and hair color added
+- Job title added
+- More email domains added
+- Bugs Fixed
+
+## [v0.2.1] - 12-10-2022
+
+- More variation added to the data
+- Test cases added
+- Created a separate file for data loadings
+- Fixed some bugs
+
+
+## [V0.0.1] - 19-03-2020
+
+- Initial Release

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing to RandomProfileGenerator
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## Steps to contribute
+
+- Comment on the issue you want to work on. Make sure it's not assigned to someone else.
+
+### 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.
+
+- Fork the repo and clone it on your machine.
+- Add a upstream link to main branch in your cloned repo
+
+    ```sh
+    git remote add upstream https://github.com/py-contributors/RandomProfileGenerator.git
+    ```
+
+- 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
+    ```
+
+- Create your feature branch
+
+    ```sh
+    git checkout -b <feature-name>
+    ```
+
+- Commit all the changes
+
+    ```sh
+    git commit -am "Meaningful commit message"
+    ```
+
+- Push the changes for review
+
+    ```sh
+    git push origin <branch-name>
+    ```
+
+- Create a PR from our repo on Github.
+
+### Additional Notes
+
+- Any changes should be made in the `dev` branch.
+- Changes should be logged in the `CHANGELOG.md` file.
+- Code should be properly commented to ensure it's readability.
+- If you've added code that should be tested, add tests as comments.
+- Make sure your code properly formatted.
+- Issue that pull request!
+
+## Issue suggestions/Bug reporting
+
+When you are creating an issue, make sure it's not already present. Furthermore, provide a proper description of the changes. If you are suggesting any code improvements, provide through details about the improvements.
+
+**Great Issue suggestions** tend to have:
+
+- A quick summary of the changes.
+- In case of any bug provide steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+  - What you expected would happen
+  - What actually happens
+  - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its  [MIT License](http://choosealicense.com/licenses/mit/).

README.md

@@ -1,7 +1,8 @@
 <h1 align="center">
-  <br>
-  Random Profile Generator V0.2.3
-  <br>
+  <a href="https://pypi.org/project/random-profile/">
+  Random Profile Generator
+  </a>
+  V0.2.3
 </h1>
 
 <h4 align="center">Python Module To Generate Random Profile Data</h4>
@@ -10,6 +11,7 @@
 <img src="https://img.shields.io/pypi/v/random-profile.svg">
 <img src="https://img.shields.io/pypi/pyversions/random-profile.svg">
 <img src="https://img.shields.io/pypi/l/random-profile.svg">
+
 </p>
 <p align="center">
 <img src="https://img.shields.io/pypi/dd/random-profile.svg">
@@ -36,98 +38,36 @@ conda install random-profile # using anaconda
 ```python
 from random_profile import RandomProfile
 rp = RandomProfile(num=5)
-'''
-
-num = Total No. of Name You Want To Print
-default is 1
-change the num value according to your needs.
-'''
-# num can be overwritten in the function
-
-# For first name
-rp.first_name(num=10)
-
-# For full name
-rp.full_name(num=8)
 
-# override the num value
 rp.full_profile(num=10)
-
-# For last name
-rp.last_name(num=6)
 ```
 
+for detailed documentation check [here](https://randomprofilegenerator.readthedocs.io/)
+
 ### As Command Line Tool
 
 ```bash
 random-profile --help
 Usage: random-profile [OPTIONS]
-
-usage: random_profile [-h] [-n N] [-f | -p | -l | -ip | -j]
-
-optional arguments:
-  -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
 ```
 
 ```bash
-random-profile -n 10 -f # to get 10 full names
-random-profile -n 10 -p # to get 10 full profiles
-random-profile -n 10 -l # to get 10 last names
-random-profile -n 10 -ip # to get 10 ipv4 addresses
-random-profile -n 10 -j # to get 10 job titles
+random-profile -n 10 -p
 ```
 
+for detailed documentation check [here](https://randomprofilegenerator.readthedocs.io/)
 
-## Support
+## Upcoming Features
 
-Contributors for the Project
-[CodePerfectPLus](https://github.com/codePerfectPlus)
-...
-
-## Roadmap
-
-what's new in future update
-
-- More Random data will be added to package.
-- Variety of Random-Data will increase.
+- Support for more languages
 
 ## Changelog
 
-v0.2.3
-- Flask app added
-- Date of Birth Added
-- Age added
-- Height and Weight Added
-- Blood Group and hair color added
-- Job title added
-- More email domains added
-- Bugs Fixed
-
-v0.2.1
-- More variation added to the data
-- Test cases added
-- Created a separate file for data loadings
-- Fixed some bugs
+Check the [Changelog](/CHANGELOG.md) for the latest changes.
 
 ## Contributing
 
-Before submitting a bug, please do the following:
-
-Perform basic troubleshooting steps:
-
-- Make sure you are on the latest version. If you are not on the most recent version, your problem may have been solved already! Upgrading is always the best first step.
-- Try older versions. If you are already on the latest release, try rolling back a few minor versions (e.g. if on 1.7, try 1.5 or 1.6) and see if the problem goes away. This will help the devs narrow down when the problem first arose in the commit log.
-- Try switching up dependency versions. If the software in question has dependencies (other libraries, etc) try upgrading and downgrading those dependencies as well.
-
-## Authors and acknowledgment
-
-Show your appreciation to those who have contributed to the project.
+Check the [Contributing](/CONTRIBUTING.md) for the contribution guidelines.
 
 ## License
 

api/api.py

@@ -10,14 +10,17 @@
 app = FastAPI()
 
 query_model = create_model("num", num=(int, ...))
+api_version = "0.2.3"
 
 
 @app.get("/")
 def index():
-    return {"status": "200", "message": "Welcome to Random Profile Generator API", "version": "0.2.3"}
+    return {"status": "200",
+            "message": "Welcome to Random Profile Generator API",
+            "version": api_version}
 
 
-@app.get('/api/v1/random_profile')
+@app.get('/api/v1/random_profile/full_profile')
 async def multiple_profile(params: query_model = Depends()):
     """ Get multiple profile with all details
 
@@ -26,7 +29,10 @@ async def multiple_profile(params: query_model = Depends()):
     """
     params_as_dict = params.dict()
     if params_as_dict['num'] > 100:
-        return {"status": "400", "message": "Number of profiles should be less than 100"}
+        return {"status": "400",
+                "message": "Number of profiles should be less than 100",
+                "version": api_version}
+
     num = params_as_dict['num']
     profile = rp.full_profile(num)
     return profile
@@ -42,7 +48,10 @@ async def multiple_first_name(params: query_model = Depends()):
     """
     params_as_dict = params.dict()
     if params_as_dict['num'] > 100:
-        return {"status": "400", "message": "Number of profiles should be less than 100"}
+        return {"status": "400",
+                "message": "Number of profiles should be less than 100",
+                "version": api_version}
+
     num = params_as_dict['num']
     first_names = rp.first_name(num)
     return first_names
@@ -58,7 +67,10 @@ async def multiple_last_name(params: query_model = Depends()):
     """
     params_as_dict = params.dict()
     if params_as_dict['num'] > 100:
-        return {"status": "400", "message": "Number of profiles should be less than 100"}
+        return {"status": "400",
+                "message": "Number of profiles should be less than 100",
+                "version": api_version}
+
     num = params_as_dict['num']
     last_names = rp.last_name(num)
     return last_names
@@ -74,7 +86,10 @@ async def multiple_full_name(params: query_model = Depends()):
     """
     params_as_dict = params.dict()
     if params_as_dict['num'] > 100:
-        return {"status": "400", "message": "Number of profiles should be less than 100"}
+        return {"status": "400",
+                "message": "Number of profiles should be less than 100",
+                "version": api_version}
+
     num = params_as_dict['num']
 
     full_names = rp.full_name(num)
@@ -86,7 +101,7 @@ def custom_openapi():
         return app.openapi_schema
     openapi_schema = get_openapi(
         title="Random Profile Generator API",
-        version="0.2.3",
+        version=api_version,
         description="Python Module To Generate Random Profile Data",
         routes=app.routes,
     )