diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 604f089..bdc2f3e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -33,6 +33,4 @@ jobs: run: | python -m pip install --upgrade pip pip install flake8 pytest tox tox-gh-actions - pip install -r requirements.txt - # - name: Test with tox - # run: tox \ No newline at end of file + pip install -r requirements.txt \ No newline at end of file diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c986263..93ac7c7 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,7 +1,7 @@ # Read the Docs configuration file for Sphinx projects # Required -version: 0.0.5 +version: 0.0.4 # Set the OS, Python version and other tools you might need build: diff --git a/PyPi.md b/PyPi.md index 7c912c0..c643217 100644 --- a/PyPi.md +++ b/PyPi.md @@ -5,16 +5,10 @@ Ficto is a Python package that allows you to effortlessly generate realistic dem ## Installation & Quick Start To install Ficto, use the following `pip` command: - -```bash -pip install ficto -``` +`pip install ficto` Generate a dataset by providing a YAML configuration file, the number of rows, and the desired file format. For example, to generate a CSV file with 100 rows using a configuration file named config.yaml, run the following command: - -```bash -ficto -d config.yaml -n 100 -f csv -``` +`ficto -d config.yaml -n 100 -f csv` ## Features * **Flexible Configuration:** Customize your dataset by defining columns and their types in a YAML file. @@ -30,9 +24,8 @@ You can find a template [here](https://github.com/taeefnajib/ficto/blob/main/con 2. **Generate Data:** Use the Ficto CLI to generate data based on your configuration. -```bash -ficto -d config.yaml -n 100 -f csv -``` +`ficto -d config.yaml -n 100 -f csv` + This command generates a CSV file inside a newly created `data` folder with 100 rows of demo data based on your data configuration file (i.e.`config.yaml`). ## Documentation diff --git a/setup.py b/setup.py index 951e520..4a4dbc9 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ with open("PyPi.md", "r", encoding="utf-8") as f: long_description = f.read() -__version__ = "0.0.5" +__version__ = "0.0.4" REPO_NAME = "ficto" AUTHOR_USER_NAME = "taeefnajib"