Skip to content

Commit 1a55803

Browse files
authored
refactor: move data simulation to another package (#55)
1 parent 9a3a0b9 commit 1a55803

15 files changed

+711
-8472
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,5 +140,4 @@ cython_debug/
140140
.vscode
141141

142142
# Data files
143-
*.parquet
144143
*.csv

README.md

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -18,33 +18,7 @@ pip install pyretailscience
1818

1919
## Quick Start
2020

21-
### Generating Simulated Data
22-
23-
The `pyretailscience` package provides a command-line interface for generating simulated transaction data.
24-
25-
#### Usage
26-
27-
```bash
28-
pyretailscience --config_file=<config_file_path> [--verbose=<True|False>] [--seed=<seed_number>] [output]
29-
```
30-
31-
#### Options and Arguments
32-
33-
- `--config_file=<config_file_path>`: The path to the configuration file for the simulation. This is a required argument.
34-
- `--verbose=<True|False>`: Optional. Set to `True` to see debug messages. Default is `False`.
35-
- `--seed=<seed_number>`: Optional. Seed for the random number generator used in the simulation. If not provided, a random seed will be used.
36-
- `[output]`: Optional. The path where the generated transactions will be saved in parquet format. If not provided, the transactions will be saved in the current directory.
37-
38-
#### Examples
39-
40-
```bash
41-
# Get the default transaction config file
42-
wget https://raw.githubusercontent.com/Data-Simply/pyretailscience/0.3.0/data/default_data_config.yaml
43-
# Generate the data file
44-
pyretailscience --config_file=default_data_config.yaml --seed=123 transactions.parquet
45-
```
46-
47-
This command will generate a file named `transactions.parquet` with the simulated transaction data, using the configuration file at default data configuration file, and a seed of `123` for the random number generator.
21+
Coming Soon
4822

4923
# Contributing
5024

0 commit comments

Comments
 (0)