generate-dummyf Python Package

Overview

The generate-dummyf Python package is a versatile tool for generating dummy files in different formats such as JSON, Excel, DOCX, TXT, and CSV. This package simplifies the process of creating sample data files for testing, development, and other purposes.

Features

Generate dummy data files in Json, Xlsx, Docx, Txt, and Csv formats. Easily specify the file size, the structure (columns and their data type) of files, path for saving your output file. Generate a file with random data for a wide range of use cases.

NOTE: file_size is a mandatory argument for each generate_* function whose value should be in bytes and the size of the output file may not be exactly equal to the user's file_size input

Installation

You can install the package using pip:

pip install generate-dummyf

Usage

Here's a quick guide on how to use the generate-dummyf package to generate dummy files:

1. Import the package

   from generate_dummyf import *
   

2. Generate a JSON file

   json_data = generate_json(file_size=50000)
   json_data = generate_json(file_size=50000, column_description={"Contact" : "int", "Name" : "str", "Status": "boolean", "Created_Time": "datetime", "Amount": "float"})
   json_data = generate_json(file_size=50000, save_file_path="/home/user-pc/Documents/")
   

3. Generate an Excel file

   excel_data = generate_excel(file_size=50000)
   excel_data = generate_excel(file_size=50000, column_description={"Contact" : "int", "Name" : "str", "Status": "boolean", "Created_Time": "datetime", "Amount": "float"})
   excel_data = generate_excel(file_size=50000, save_file_path="/home/user-pc/Documents/")
   

4. Generate a CSV file

   csv_data = generate_csv(file_size=5000)
   csv_data = generate_csv(file_size=5000, column_description={"Contact" : "int", "Name" : "str", "Status": "boolean", "Created_Time": "datetime", "Amount": "float"})
   csv_data = generate_csv(file_size=50000, save_file_path="/home/user-pc/Documents/")
   

5. Generate a DOCX file

   docx_data = generate_word(file_size=50000)
   docx_data = generate_word(file_size=50000, font_size = 30, save_file_path="/home/user-pc/Documents/")
   

6. Generate a TXT file

   text_data = generate_txt(file_size=5000)
   txt_data = generate_txt(file_size=50000, save_file_path="/home/user-pc/Documents/")
   

7. View the generated files

   By default, the generated files will be saved in the downloads directory; however, you can manually specify the path using the save_file_path argument

Run the tests (For developers)

python -m unittest tests/test_csv.py 
python -m unittest tests/test_excel.py 
python -m unittest tests/test_json.py 
python -m unittest tests/test_txt.py 
python -m unittest tests/test_word.py 

Contributing

Contributions to generate-dummyf are welcome! If you'd like to contribute to this project, please follow our contribution guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support and Contact

If you have any questions, issues, or feature requests, please feel free to open an issue.