# RandoMorph
The **RandoMorph** is a simple Python library designed for generating random data of various types, including strings, names, addresses, numbers, and more. This library is ideal for creating test data, mock-ups, or demonstration samples.
## Table of Contents
* [Getting Started](#getting-started)
* [Installation](#installation)
* [Usage](#usage)
* [**Arguments**](#arguments)
## Getting Started
### Installation
#### Install using pypi
```bash
pip install randomorph
```
or
* Clone the GitHub repository:
```bash
git clone https://github.com/soyll/RandoMorph.git
```
* Navigate to directory:
```bash
cd RandoMorph
```
* (Recommended) Create a virtual environment to manage Python packages for your project:
```bash
python3 -m venv venv
```
* Activate the virtual enviropment
* On windows:
```bash
.\venv\Scripts\activate
```
* On linux or macOs:
```
source venv/bin/activate
```
* Install the required Python packages from `requirements.txt`:
```bash
pip install -r requirments.txt
```
## Usage
```python
import RandoMorph
# later... ---> ???
```
## Arguments
| Argument Name | Description | Conditions | Example |
| --- | --- | --- | --- |
| `sample` | Examples of data that should be included in the file. Can include addresses, dates, email addresses, user IDs, and names. Multiple options can be specified in any order. | Options: `Address`, `Date`, `Email`, `User_id`, `Name`. Multiple options can be used in different combinations. | `sample='Name' 'Email'` |
| `length` | The length of the table, i.e., the number of rows in the generated file. Limited to values less than 100. | Integer `1<N<100`. | `length=50` |
| `filename` | The name of the file and its extension in which the result will be saved. | A string with a valid file extension (e.g., 'xlsx', 'png', 'json', 'csv'). | `filename='sample_data.xlsx'` |
| `output_path` | The path where the file will be saved. | A string representing the directory path where the file should be saved. | `output_path='/path/to/save/'` |
Raw data
{
"_id": null,
"home_page": "https://github.com/soyll/RandoMorph",
"name": "RandoMorph",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "test python generate random randomorph",
"author": "soyll",
"author_email": "soyll@vk.com",
"download_url": "https://files.pythonhosted.org/packages/85/72/0be9660aa194337997e1f1c6ae1faf2951cf39235ad70b35534fce249633/RandoMorph-0.0.8.tar.gz",
"platform": null,
"description": "# RandoMorph\r\nThe **RandoMorph** is a simple Python library designed for generating random data of various types, including strings, names, addresses, numbers, and more. This library is ideal for creating test data, mock-ups, or demonstration samples.\r\n\r\n## Table of Contents\r\n* [Getting Started](#getting-started)\r\n * [Installation](#installation)\r\n* [Usage](#usage)\r\n* [**Arguments**](#arguments)\r\n\r\n## Getting Started\r\n\r\n### Installation\r\n#### Install using pypi\r\n```bash\r\npip install randomorph\r\n```\r\nor\r\n* Clone the GitHub repository:\r\n\t```bash\r\n\tgit clone https://github.com/soyll/RandoMorph.git\t\r\n\t```\r\n* Navigate to directory:\r\n\t```bash\r\n\tcd RandoMorph\t\r\n\t```\r\n* (Recommended) Create a virtual environment to manage Python packages for your project:\r\n\t```bash\r\n\tpython3 -m venv venv\r\n\t```\r\n* Activate the virtual enviropment\r\n\t* On windows:\r\n\t\t```bash\r\n\t\t.\\venv\\Scripts\\activate\r\n\t\t``` \r\n\t* On linux or macOs:\r\n\t\t```\r\n\t\tsource venv/bin/activate\r\n\t\t```\r\n* Install the required Python packages from `requirements.txt`:\r\n\t```bash\r\n\tpip install -r requirments.txt\r\n\t```\r\n## Usage\r\n\r\n```python\r\nimport RandoMorph\r\n\r\n# later... ---> ???\r\n```\r\n\r\n## Arguments\r\n| Argument Name | Description | Conditions | Example |\r\n| --- | --- | --- | --- |\r\n| `sample` | Examples of data that should be included in the file. Can include addresses, dates, email addresses, user IDs, and names. Multiple options can be specified in any order. | Options: `Address`, `Date`, `Email`, `User_id`, `Name`. Multiple options can be used in different combinations. | `sample='Name' 'Email'` |\r\n| `length` | The length of the table, i.e., the number of rows in the generated file. Limited to values less than 100. | Integer `1<N<100`. | `length=50` |\r\n| `filename` | The name of the file and its extension in which the result will be saved. | A string with a valid file extension (e.g., 'xlsx', 'png', 'json', 'csv'). | `filename='sample_data.xlsx'` |\r\n| `output_path` | The path where the file will be saved. | A string representing the directory path where the file should be saved. | `output_path='/path/to/save/'` |\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A simple Python library for generating random data of various types, including strings, names, addresses, numbers, and more.",
"version": "0.0.8",
"project_urls": {
"GitHub": "https://github.com/soyll",
"Homepage": "https://github.com/soyll/RandoMorph"
},
"split_keywords": [
"test",
"python",
"generate",
"random",
"randomorph"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d826702832cecc2ba58d6891977cb6a6d7c1723575c75c9b55d925f6a238f680",
"md5": "7e478721a08878eb4b33d1d50a3a0a50",
"sha256": "dbd3a1da26ef3092bfbaa797cbab3eb50d858cdb0b2023430bc8f7cfc22d29d5"
},
"downloads": -1,
"filename": "RandoMorph-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7e478721a08878eb4b33d1d50a3a0a50",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3315,
"upload_time": "2023-10-04T16:15:04",
"upload_time_iso_8601": "2023-10-04T16:15:04.179853Z",
"url": "https://files.pythonhosted.org/packages/d8/26/702832cecc2ba58d6891977cb6a6d7c1723575c75c9b55d925f6a238f680/RandoMorph-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85720be9660aa194337997e1f1c6ae1faf2951cf39235ad70b35534fce249633",
"md5": "f1f04d4ba0ce772afeeaca474e120799",
"sha256": "4e0e35d4df35e4ffe30ad6b716cb539dd1ca7df81512fec8004e514cf596a0b7"
},
"downloads": -1,
"filename": "RandoMorph-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "f1f04d4ba0ce772afeeaca474e120799",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3142,
"upload_time": "2023-10-04T16:15:05",
"upload_time_iso_8601": "2023-10-04T16:15:05.898946Z",
"url": "https://files.pythonhosted.org/packages/85/72/0be9660aa194337997e1f1c6ae1faf2951cf39235ad70b35534fce249633/RandoMorph-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-04 16:15:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "soyll",
"github_project": "RandoMorph",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "randomorph"
}
JSON
