From 3ce8c461926a14b91abe5971f2a821bebe248bb1 Mon Sep 17 00:00:00 2001
From: Peter Muriuki <pmuriuki98@gmail.com>
Date: Thu, 17 Oct 2024 14:06:21 +0300
Subject: [PATCH] Rename cli.py to faker-clie

---
 importer/stub_data_gen/Readme.md                | 16 ++++++++++++----
 importer/stub_data_gen/{cli.py => faker-cli.py} |  6 +++---
 2 files changed, 15 insertions(+), 7 deletions(-)
 rename importer/stub_data_gen/{cli.py => faker-cli.py} (99%)

diff --git a/importer/stub_data_gen/Readme.md b/importer/stub_data_gen/Readme.md
index 9444a68f..201387f1 100644
--- a/importer/stub_data_gen/Readme.md
+++ b/importer/stub_data_gen/Readme.md
@@ -1,15 +1,23 @@
 # usage
 
+Ofcourse you need to prepare your python environment and install the package dependencies
+
+```commandline
+python3 -m venv myenv
+source myenv/bin/activate
+pip instal -r ../requirements.txt
+```
+
 **To generate data for all resources**
 
 ```commandline
-python cli.py generate
+python faker-cli generate
 ```
 
 **Generate data for a single resource**
 
 ```commandline
-python cli.py generate users --count=100
+python faker-cli generate users --count=100
 ```
 
 **Generate single resource that requires pre-generated data like assignments**
@@ -17,11 +25,11 @@ python cli.py generate users --count=100
 e.g. When assigning users to organizations, provide individual csvs containing the users and organizations data
 
 ```commandline
-python cli.py generate users-orgs --orgs-csv=<orgs-csv-path> --users-csv=<users-csv-path>
+python faker-cli generate users-orgs --orgs-csv=<orgs-csv-path> --users-csv=<users-csv-path>
 ```
 
 **Learn more**
 
 ```commandline
-python cli.py generate --help
+python faker-cli generate --help
 ```
\ No newline at end of file
diff --git a/importer/stub_data_gen/cli.py b/importer/stub_data_gen/faker-cli.py
similarity index 99%
rename from importer/stub_data_gen/cli.py
rename to importer/stub_data_gen/faker-cli.py
index 54b2c197..70f97235 100644
--- a/importer/stub_data_gen/cli.py
+++ b/importer/stub_data_gen/faker-cli.py
@@ -9,7 +9,7 @@
 
 
 @click.group()
-def cli():
+def faker():
     pass
 
 
@@ -157,7 +157,7 @@ def organizations(ctx):
     click.echo(f"Organization data generated and saved in {out_dir}")
 
 
-cli.add_command(generate)
+faker.add_command(generate)
 
 generate.add_command(users)
 generate.add_command(careteams)
@@ -169,4 +169,4 @@ def organizations(ctx):
 generate.add_command(organizations)
 
 if __name__ == '__main__':
-    cli()
\ No newline at end of file
+    faker()
\ No newline at end of file