Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
vadimooo committed Apr 22, 2024
1 parent 06f2adf commit 5168cf2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@
- Download and install Python version 3.12+ from https://www.python.org/downloads/
- Install Dataforge by running:
- pip install dataforge-core
- Install beta
- Install latest beta release:
- pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ dataforge-core

## Usage
### Command
<code>dataforge [-h] [--init] [--seed] [--connect "Postgres connection string"] [Project Path]</code>
<code>dataforge [-h] [--init] [--seed] [--connect "Postgres connection string"]
[--connect_databricks "Databricks host URL"] [--http_path <Databricks SQL warehouse http path>]
[--access_token "Databricks SQL warehouse access token"] [--run]
[Project Path]</code>


### Arguments:
Expand All @@ -21,6 +24,10 @@
- --init, -i Initialize project folder with sample files
- --seed Deploy and seed postgres database
- --connect | -c "Postgres connection string" Connect to, deploy and initialize postgres database
- --connect_databricks | -d "Databricks host URL" Connect to databricks SQL warehouse
- --http_path "Databricks SQL warehouse http path" Databricks SQL warehouse http path
- --access_token "Databricks SQL warehouse access token" Databricks access token
- --run | -r Execute compiled project using configured Databricks SQL warehouse connection

## Links
- https://dataforgelabs.com
2 changes: 1 addition & 1 deletion cli/dataforge/mainConfig.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def __init__(self):
_parser = argparse.ArgumentParser(
prog='dataforge',
description='Dataforge Core compiles project and generates SQL queries that create source and output tables defined in the project',
epilog='Try our cloud product')
epilog='https://github.com/dataforgelabs/dataforge-core')
_parser.add_argument('source', type=str, help='Project folder', metavar='<Project Path>', nargs='?')
_parser.add_argument('--init', '-i', action='store_true', help='Initialize project folder')
_parser.add_argument('--seed', action='store_true', help='Deploy and seed postgres database')
Expand Down

0 comments on commit 5168cf2

Please sign in to comment.