VulcanDB

Installation

Before you start the installation process make sure you have python installed.

1 Clone this repositor on your local machine:

git clone [email protected]:vulcanDB/vulcanDB.git

2 Move inside the main project directory:

cd vulcanDB

3 Setup and activate your virtual environment (optional):

# To create a virtual env:
python -m venv .venv    # For Windoes & Linux
python3  -m venv .venv  # If you're on MacOS

# For activation use one of the following commands based on your OS:
`source .venv/bin/activate`   # On Mac / Linux
.venv\Scripts\activate.bat  # In Windows CMD
.venv\Scripts\Activate.ps1  # In Windows Powershel

4 Install the required packages from the requirements.txt file:

pip install -r requirements.txt

Setting Up Your Application

Before launching the application, follow these steps to configure your environment:

Create .env file

1. Duplicate the provided example.env file.
2. Rename the duplicated file to .env.
3. Open the .env file and insert the secrets and configurations required for the application to function properly.

Usage

Here's how you can use Vulcan:

From the root directory execute the following command:

python -m vulcan -f <input_file_name>

Replace <input_file_name> with the name of the file for which you want to generate SQL queries.

Options

-f: Specifies the file name for which SQL queries will be generated. This is a required argument. To know more about other options, you can execute the following command:

To know more about other options you can execute the following command:

python -m vulcan -h

This will display the help message and exit, showing optional arguments:

optional arguments:
  -h, --help            show this help message and exit
  -f FILE_NAME          File name

Tests

To execute tests you can use the following command:

pytest