gendit


Namegendit JSON
Version 1.0.0a2 PyPI version JSON
download
home_pageNone
Summarysimple large scale data generator
upload_time2024-06-05 03:29:45
maintainerNone
docs_urlNone
authorFabien Arcellier
requires_python<4.0,>=3.10
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## Geni

[![ci](https://github.com/FabienArcellier/geni/actions/workflows/main.yml/badge.svg)](https://github.com/FabienArcellier/blueprint-python3/actions/workflows/main.yml)

Geni helps you generate large-scale datasets.

```python
import geni
from faker import Faker

fake = Faker()

# Create a generator
def generator() -> dict:
    return {
        "name": fake.name(),
        "age": fake.random_int(18, 99),
        "city": fake.city()
    }

geni.generate_file(generator, row=1000, output="data.csv")
```

## The latest version

You can find the latest version to ...

```bash
git clone https://github.com/FabienArcellier/geni.git
```

## Usage

## Developper guideline

### Add a dependency

``bash
poetry add requests
``
### Install development environment

Use make to instanciate a python virtual environment in ./venv and install the
python dependencies.

```bash
poetry install
```

### Update release dependencies

Use make to instanciate a python virtual environment in ./venv and freeze
dependencies version

```bash
poetry update update
```

### Activate the python environment

When you setup the requirements, a `venv` directory on python 3 is created.
To activate the venv, you have to execute :

```bash
poetry shell
```

### Run the continuous integration process

Before commit or send a pull request, you have to execute `pylint` to check the syntax
of your code and run the unit tests to validate the behavior.

```bash
$ poetry run alfred ci
```

## Contributors

* Fabien Arcellier

## License

MIT License

Copyright (c) 2024-2024 Fabien Arcellier

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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "gendit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Fabien Arcellier",
    "author_email": "fabien.arcellier@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/f7/11/1529c5388678eb7945e7763fceef416abfabb00c39149d40d52058ba672e/gendit-1.0.0a2.tar.gz",
    "platform": null,
    "description": "## Geni\n\n[![ci](https://github.com/FabienArcellier/geni/actions/workflows/main.yml/badge.svg)](https://github.com/FabienArcellier/blueprint-python3/actions/workflows/main.yml)\n\nGeni helps you generate large-scale datasets.\n\n```python\nimport geni\nfrom faker import Faker\n\nfake = Faker()\n\n# Create a generator\ndef generator() -> dict:\n    return {\n        \"name\": fake.name(),\n        \"age\": fake.random_int(18, 99),\n        \"city\": fake.city()\n    }\n\ngeni.generate_file(generator, row=1000, output=\"data.csv\")\n```\n\n## The latest version\n\nYou can find the latest version to ...\n\n```bash\ngit clone https://github.com/FabienArcellier/geni.git\n```\n\n## Usage\n\n## Developper guideline\n\n### Add a dependency\n\n``bash\npoetry add requests\n``\n### Install development environment\n\nUse make to instanciate a python virtual environment in ./venv and install the\npython dependencies.\n\n```bash\npoetry install\n```\n\n### Update release dependencies\n\nUse make to instanciate a python virtual environment in ./venv and freeze\ndependencies version\n\n```bash\npoetry update update\n```\n\n### Activate the python environment\n\nWhen you setup the requirements, a `venv` directory on python 3 is created.\nTo activate the venv, you have to execute :\n\n```bash\npoetry shell\n```\n\n### Run the continuous integration process\n\nBefore commit or send a pull request, you have to execute `pylint` to check the syntax\nof your code and run the unit tests to validate the behavior.\n\n```bash\n$ poetry run alfred ci\n```\n\n## Contributors\n\n* Fabien Arcellier\n\n## License\n\nMIT License\n\nCopyright (c) 2024-2024 Fabien Arcellier\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "simple large scale data generator",
    "version": "1.0.0a2",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f3c767746ad45571927e85a153e5ea99c6a2cf9fbc893e1521c3416a043f8aaf",
                "md5": "f9f1a642c8a44a493ef1e606354542c8",
                "sha256": "b056f638cc806b7a2f6a18966ede56c082d06eed3e881641455cbc6c60fb88fd"
            },
            "downloads": -1,
            "filename": "gendit-1.0.0a2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f9f1a642c8a44a493ef1e606354542c8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 5702,
            "upload_time": "2024-06-05T03:29:44",
            "upload_time_iso_8601": "2024-06-05T03:29:44.241977Z",
            "url": "https://files.pythonhosted.org/packages/f3/c7/67746ad45571927e85a153e5ea99c6a2cf9fbc893e1521c3416a043f8aaf/gendit-1.0.0a2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f7111529c5388678eb7945e7763fceef416abfabb00c39149d40d52058ba672e",
                "md5": "18ddb9bf9fb2d8d312ef3defa2852330",
                "sha256": "3902f1fa9f2b62a815dac6e5237e3e7ec20bc28747c0f6c5eacdb2b6c561a084"
            },
            "downloads": -1,
            "filename": "gendit-1.0.0a2.tar.gz",
            "has_sig": false,
            "md5_digest": "18ddb9bf9fb2d8d312ef3defa2852330",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 4381,
            "upload_time": "2024-06-05T03:29:45",
            "upload_time_iso_8601": "2024-06-05T03:29:45.841100Z",
            "url": "https://files.pythonhosted.org/packages/f7/11/1529c5388678eb7945e7763fceef416abfabb00c39149d40d52058ba672e/gendit-1.0.0a2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-05 03:29:45",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "gendit"
}
        
Elapsed time: 0.25731s