Skip to content

Commit 6f73ba9

Browse files
updating docs
1 parent b3b5097 commit 6f73ba9

11 files changed

+202
-178
lines changed

.gitignore

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
.vscode
9+
10+
# Distribution / packaging
11+
.Python
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
pip-wheel-metadata/
25+
share/python-wheels/
26+
*.egg-info/
27+
.installed.cfg
28+
*.egg
29+
MANIFEST
30+
31+
# PyInstaller
32+
# Usually these files are written by a python script from a template
33+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
34+
*.manifest
35+
*.spec
36+
37+
# Installer logs
38+
pip-log.txt
39+
pip-delete-this-directory.txt
40+
41+
# Unit test / coverage reports
42+
htmlcov/
43+
.tox/
44+
.nox/
45+
.coverage
46+
.coverage.*
47+
.cache
48+
nosetests.xml
49+
coverage.xml
50+
*.cover
51+
*.py,cover
52+
.hypothesis/
53+
.pytest_cache/
54+
55+
# Translations
56+
*.mo
57+
*.pot
58+
59+
# Django stuff:
60+
*.log
61+
local_settings.py
62+
db.sqlite3
63+
db.sqlite3-journal
64+
65+
# Flask stuff:
66+
instance/
67+
.webassets-cache
68+
69+
# Scrapy stuff:
70+
.scrapy
71+
72+
# Sphinx documentation
73+
docs/_build/
74+
75+
# PyBuilder
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
.python-version
87+
88+
# pipenv
89+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
90+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
91+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
92+
# install all needed dependencies.
93+
#Pipfile.lock
94+
95+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
96+
__pypackages__/
97+
98+
# Celery stuff
99+
celerybeat-schedule
100+
celerybeat.pid
101+
102+
# SageMath parsed files
103+
*.sage.py
104+
105+
# Environments
106+
.env
107+
.venv
108+
env/
109+
venv/
110+
ENV/
111+
env.bak/
112+
venv.bak/
113+
114+
# Spyder project settings
115+
.spyderproject
116+
.spyproject
117+
118+
# Rope project settings
119+
.ropeproject
120+
121+
# mkdocs documentation
122+
/site
123+
124+
# mypy
125+
.mypy_cache/
126+
.dmypy.json
127+
dmypy.json
128+
129+
# Pyre type checker
130+
.pyre/

build/lib/random_profile/__init__.py

-83
This file was deleted.
-4.56 KB
Binary file not shown.
-4.63 KB
Binary file not shown.
-4.62 KB
Binary file not shown.
-4.63 KB
Binary file not shown.

docs/README.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Random Profile Generator
2+
##### Introduction
3+
randomname is a powerful and simple tool to generate fake data. You can use it to mock classes, populate databases and and much more. You can check the full documentation here.
4+
5+
```python
6+
pip install random-profile
7+
```
8+
### Documentation
9+
```python
10+
#firt create a object for class 'Name'
11+
import random_profile as rp
12+
name = rp.Name(num=1)
13+
'''
14+
num = Total No. of Name You Want To Print
15+
deafult is 1
16+
To Print More Than one Name Change value of num
17+
'''
18+
# For First Name
19+
name.first_name()
20+
21+
# For First Name
22+
name.full_name()
23+
24+
# For First Name
25+
name.full_profile()
26+
```
27+
## Installation
28+
29+
- This is A python 3 pacakge.
30+
- Install python 3.0+ or Anaconda 3.0+
31+
32+
```python
33+
Pip install random-profile #on python
34+
conda install random-profile # on anacoda
35+
```
36+
## Usage
37+
random-profile module is a random profile generator for many usages ex- fake dataset,youtube videos, content creation, personal projects.
38+
39+
## Support
40+
Cotributors for the Project
41+
[CodePerfectPLus](https://github.com/codePerfectPlus)
42+
...
43+
44+
## Roadmap
45+
what's new in future update
46+
- More Random data will be added to package.
47+
- variety of Random-Data will increase.
48+
49+
## Contributing
50+
Before submitting a bug, please do the following:
51+
52+
Perform basic troubleshooting steps:
53+
54+
- 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.
55+
- 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.
56+
- Try switching up dependency versions. If the software in question has dependencies (other libraries, etc) try upgrading/downgrading those as well.
57+
58+
## Authors and acknowledgment
59+
Show your appreciation to those who have contributed to the project.
60+
61+
## License
62+
For open source projects,Under MIT License.
63+
64+
## Project status
65+
66+
## Author
67+
- Module : random-profile
68+
- Author : CodePerfectPlus
69+
- Language : Python
70+
- Github : https://github.com/codePerfectPlus
71+
- Website : http://codeperfectplus.github.io/
72+

random_profile.egg-info/PKG-INFO

-86
This file was deleted.

random_profile.egg-info/SOURCES.txt

-7
This file was deleted.

random_profile.egg-info/dependency_links.txt

-1
This file was deleted.

random_profile.egg-info/top_level.txt

-1
This file was deleted.

0 commit comments

Comments
 (0)