Skip to content

Commit

Permalink
PyPi description is fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
taeefnajib committed Nov 24, 2023
1 parent b4ff679 commit a9e1755
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 16 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
pip install -r requirements.txt
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
15 changes: 4 additions & 11 deletions PyPi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit a9e1755

Please sign in to comment.