fabricator/README.md
Eero Holmala 7a4f707f39 Added basic argument parser. Started some class
stubs for reading and storing data. Also added README.
2024-01-23 13:32:30 +02:00

41 lines
903 B
Markdown

# Fabricator
## Summary
Fabricator is a data generation tool for myself, but might be useful for others too. This is mainly practice for object oriented programming and I won't attempt to refactor this to anything else.
## Features
* [ ] Generate Names
* [ ] Generate Phone
* [ ] Generate Addresses
* [ ] Output to different file formats:
* [ ] CSV
* [ ] JSON
* [ ] XML
* [ ] YAML
* [ ] TOML
* [ ] Cross platform:
* [ ] Windows
* [ ] MacOS
* [ ] Linux
## Usage
Basic usage:
```sh
$ fab gen -n 10 -f csv -o output.csv name:phone:address
```
This will output a CSV file named 'output.csv' with 10 rows randomly of generated data for names, phone numbers and addresses.
## Building
For debug build run
```sh
dotnet build
```
Running the tool directly with dotnet i.e.
```sh
dotnet run -- gen -n 10 -f csv -o output.csv name:phone:address
```
## Licensing
MIT License