Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# Environments
.env
.venv
env/
venv/
ENV/
20 changes: 16 additions & 4 deletions docs/2_scripting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,19 @@ Python is the primary scripting language used in this project. To ensure consist

To use the scripts in the scripts directory, be sure you have the dependencies installed:

```sh
pip install mysql-connector-python
pip install future
pip install pysword
pip install PyYAML
pip install pyarrow
pip install pymysql
```
pip install mysql.connector
pip install past.builtins
pip install pysword.modules
pip install yaml

You may also install all PyPI dependencies from the root project directory with:

```sh
python -m pip install -r requirements.txt
```

### Scripts Breakdown
Expand Down Expand Up @@ -59,6 +67,10 @@ pip install yaml
- **Description**: Generates MySQL SQL dump files for Bible translations. Each translation is processed and output as an SQL dump file.
- **Usage**: Run the script to create SQL dump files for each translation.

#### `generate_parquet.py`
- **Description**: Generate Parquet files for Bible translations. Each translation is processed and output as a .parquet file.
- **Usage**: Run the script to create .parquet files for each translation.

#### `generate_psql.py`
- **Description**: Generates PostgreSQL SQL dump files for Bible translations. Each translation is processed and output as an SQL dump file.
- **Usage**: Run the script to create SQL dump files for each translation.
Expand Down
12 changes: 10 additions & 2 deletions docs/4_adding_texts.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,19 @@ unique issues to overcome in conversion.

Be sure you have the dependencies for this project installed:

```
```sh
pip install mysql-connector-python
pip install future
pip install pysword
pip install pyyaml
pip install PyYAML
pip install pyarrow
pip install pymysql
```

You may also install all PyPI dependencies from the root project directory with:

```sh
python -m pip install -r requirements.txt
```

## Step One: Find the translation...
Expand Down
Loading