| Name | fillme JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | A lightweight library to generate dummy data for database using OpenAI |
| upload_time | 2024-02-24 16:32:25 |
| maintainer | |
| docs_url | None |
| author | Soheil Dolatabadi |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 SoheilStar Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
dummy data
openai
chatgpt
database
postgresql
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## FillMe with dummy data!!!
This python package helps you to populate your database with
fake data generated by ChatGPT. This will ensure the tables
relationships will be provisioned and also you have better data to work
with rather than random chars and integers!
### How to install
you can use PIP to install it by simply using
```text
pip install FillMe
```
or, you can clone this repository, create you virtual environment
and then run
```text
python setup.py install
```
### How to use it
as this repository is relying on ChatGPT to generate data, you first need to create an account on OpenAI
and get an API token. Then all you need is to add it to your OS enevironment variable or
by passing it to FillMe and it will do the rest of job!(check next steps)
then, you can use FillMe in two ways:
1- using in CLI and by passing one mandatory argument and two optional arguments:
```shell
python -m FillMe --db-url your_db_url_here --schema your_schema_name_here --openai-token your_openai_token_here
```
2- or by importing package in your python code or jupyter notebook
```python
from fillme import FillMe
from sqlalchemy import create_engine
engine = create_engine(
url='postgresql+psycopg2://user:pass@db_host:db_port/db_name', # postgres url
connect_args={'options': f"-csearch_path=schema_name"}, # schema if applicable
)
# creating instance
fillme_obj = FillMe(
engine
)
# getting tables and relationships
fillme_obj.get_tables()
# generating dummy data and storing in the tables
fillme_obj.generate_dummies()
```
Raw data
{
"_id": null,
"home_page": "",
"name": "fillme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "dummy data,openai,chatgpt,database,postgresql",
"author": "Soheil Dolatabadi",
"author_email": "Soheil Dolatabadi <soheildolat@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3c/74/54a9d7c1a43eeebe68a55e2bcab966b5b7e29aec410c9726ca01cfc24544/fillme-1.0.0.tar.gz",
"platform": null,
"description": "## FillMe with dummy data!!!\nThis python package helps you to populate your database with\nfake data generated by ChatGPT. This will ensure the tables\nrelationships will be provisioned and also you have better data to work\nwith rather than random chars and integers!\n\n\n### How to install\nyou can use PIP to install it by simply using\n```text\npip install FillMe\n```\nor, you can clone this repository, create you virtual environment \nand then run\n```text\npython setup.py install\n```\n\n### How to use it\nas this repository is relying on ChatGPT to generate data, you first need to create an account on OpenAI\nand get an API token. Then all you need is to add it to your OS enevironment variable or\nby passing it to FillMe and it will do the rest of job!(check next steps)\n\nthen, you can use FillMe in two ways:\n\n1- using in CLI and by passing one mandatory argument and two optional arguments:\n```shell\npython -m FillMe --db-url your_db_url_here --schema your_schema_name_here --openai-token your_openai_token_here\n```\n\n2- or by importing package in your python code or jupyter notebook\n```python\nfrom fillme import FillMe\nfrom sqlalchemy import create_engine\n\nengine = create_engine(\n url='postgresql+psycopg2://user:pass@db_host:db_port/db_name', # postgres url\n connect_args={'options': f\"-csearch_path=schema_name\"}, # schema if applicable\n)\n\n# creating instance\nfillme_obj = FillMe(\n engine\n)\n# getting tables and relationships\nfillme_obj.get_tables()\n# generating dummy data and storing in the tables\nfillme_obj.generate_dummies()\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 SoheilStar Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A lightweight library to generate dummy data for database using OpenAI",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/soheil-star01/fillme"
},
"split_keywords": [
"dummy data",
"openai",
"chatgpt",
"database",
"postgresql"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c7454a9d7c1a43eeebe68a55e2bcab966b5b7e29aec410c9726ca01cfc24544",
"md5": "e18f0eb7c64847fee602c2955fac10d3",
"sha256": "a8c2abe5c5844fbd6b18a1999b44fda07757e22c8b63945fe955a29713f1ae2d"
},
"downloads": -1,
"filename": "fillme-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e18f0eb7c64847fee602c2955fac10d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4105,
"upload_time": "2024-02-24T16:32:25",
"upload_time_iso_8601": "2024-02-24T16:32:25.835675Z",
"url": "https://files.pythonhosted.org/packages/3c/74/54a9d7c1a43eeebe68a55e2bcab966b5b7e29aec410c9726ca01cfc24544/fillme-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-24 16:32:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "soheil-star01",
"github_project": "fillme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "fillme"
}
