Rename from hypha to preen (#72)

Author: scottypate

.env.example

@@ -1,6 +1,6 @@
 # DEBUG | INFO | WARN | ERROR
-HYPHA_LOG_LEVEL=INFO
-# Config path for HyphaDB
-HYPHA_CONFIG_PATH=./.hypha/
-# Model path for HyphaDB
-HYPHA_MODELS_PATH=./models/
+PREEN_LOG_LEVEL=INFO
+# Config path for Preen
+PREEN_CONFIG_PATH=./.preen/
+# Model path for Preen
+PREEN_MODELS_PATH=./models/

.github/workflows/ci.yaml

@@ -5,12 +5,14 @@ on: pull_request
 jobs:
  tests:
  env:
- HYPHA_CONFIG_PATH: ./build/ci
- HYPHA_MODELS_PATH: ./build/ci/models
+ PREEN_CONFIG_PATH: ./build/ci
+ PREEN_MODELS_PATH: ./build/ci/models
  PG_USER: ${{ secrets.PG_USER }}
  PG_PASSWORD: ${{ secrets.PG_PASSWORD }}
  MYSQL_USER: ${{ secrets.MYSQL_USER }}
  MYSQL_PASSWORD: ${{ secrets.MYSQL_PASSWORD }}
+ MONGO_USER: ${{ secrets.MONGO_USER }}
+ MONGO_PASSWORD: ${{ secrets.MONGO_PASSWORD }}
  runs-on: ubuntu-latest
 
  steps:
@@ -35,7 +37,7 @@ jobs:
  version: v1.60
  args: --timeout=5m
 
- - name: Build Hypha binary
+ - name: Build Preen binary
  run: make build
 
  - name: Unit Tests
@@ -45,17 +47,17 @@ jobs:
  run: |
  sleep 5
 
- bin/hypha model build
+ bin/preen model build
 
  # Test that the MySQL model was built and can be queried. Query should return 1 row.
- MYSQL_RESULTS_LENGTH=$(bin/hypha query -f json "select * from mysql_data_types_test;" | jq length)
+ MYSQL_RESULTS_LENGTH=$(bin/preen query -f json "select * from mysql_data_types_test;" | jq length)
  if [[ $MYSQL_RESULTS_LENGTH -ne 1 ]]; then
  echo "Expected 1 row in mysql_data_types_test, got $MYSQL_RESULTS_LENGTH"
  exit 1
  fi
 
  # Test that the PostgreSQL model was built and can be queried. Query should return 1 row.
- PG_RESULTS_LENGTH=$(bin/hypha query -f json "select * from pg_data_types_test;" | jq length)
+ PG_RESULTS_LENGTH=$(bin/preen query -f json "select * from pg_data_types_test;" | jq length)
  if [[ $PG_RESULTS_LENGTH -ne 1 ]]; then
  echo "Expected 1 row in pg_data_types_test, got $PG_RESULTS_LENGTH"
  exit 1

.github/workflows/release.yaml

@@ -35,14 +35,14 @@ jobs:
  GOARCH: ${{ matrix.arch }}
  CGO_ENABLED: 1
  run: |
- CGO_ENABLED=1 CGO_LDFLAGS="-L/usr/lib" go build -o output/${{ matrix.os }}_${{ matrix.arch }}/hypha --ldflags="-extldflags=-static" -tags osusergo,netgo main.go
- tar -C output/${{ matrix.os }}_${{ matrix.arch }} -czvf hypha-${{ matrix.os }}_${{ matrix.arch }}-${{ github.event.release.tag_name }}.tar.gz hypha
+ CGO_ENABLED=1 CGO_LDFLAGS="-L/usr/lib" go build -o output/${{ matrix.os }}_${{ matrix.arch }}/preen --ldflags="-extldflags=-static" -tags osusergo,netgo main.go
+ tar -C output/${{ matrix.os }}_${{ matrix.arch }} -czvf preen-${{ matrix.os }}_${{ matrix.arch }}-${{ github.event.release.tag_name }}.tar.gz preen
  echo "Built for $GOOS $GOARCH"
 
  - name: Upload binaries
  uses: svenstaro/upload-release-action@v2
  with:
- file: hypha-${{ matrix.os }}_${{ matrix.arch }}-${{ github.event.release.tag_name }}.tar.gz
+ file: preen-${{ matrix.os }}_${{ matrix.arch }}-${{ github.event.release.tag_name }}.tar.gz
  repo_token: ${{ secrets.GITHUB_TOKEN }}
  tag: ${{ github.ref }}
 
@@ -73,13 +73,13 @@ jobs:
  GOARCH: ${{ matrix.arch }}
  CGO_ENABLED: 1
  run: |
- CGO_ENABLED=1 CGO_LDFLAGS="-L/usr/lib" go build -o output/${{ matrix.os }}_${{ matrix.arch }}/hypha main.go
- tar -C output/${{ matrix.os }}_${{ matrix.arch }} -czvf hypha-${{ matrix.os }}_${{ matrix.arch }}-${{ github.event.release.tag_name }}.tar.gz hypha
+ CGO_ENABLED=1 CGO_LDFLAGS="-L/usr/lib" go build -o output/${{ matrix.os }}_${{ matrix.arch }}/preen main.go
+ tar -C output/${{ matrix.os }}_${{ matrix.arch }} -czvf preen-${{ matrix.os }}_${{ matrix.arch }}-${{ github.event.release.tag_name }}.tar.gz preen
  echo "Built for $GOOS $GOARCH"
  
  - name: Upload binaries
  uses: svenstaro/upload-release-action@v2
  with:
- file: hypha-${{ matrix.os }}_${{ matrix.arch }}-${{ github.event.release.tag_name }}.tar.gz
+ file: preen-${{ matrix.os }}_${{ matrix.arch }}-${{ github.event.release.tag_name }}.tar.gz
  repo_token: ${{ secrets.GITHUB_TOKEN }}
  tag: ${{ github.ref }}

.gitignore

@@ -1,4 +1,4 @@
-hyphadb
+preendb
 bin/
 tmp.txt
 .config/
@@ -120,9 +120,9 @@ venv.bak/
 **plugins
 *.tfstate*
 
-# Hypha
-*hyphaContext.db*
+# Preen
+*preenContext.db*
 .docker/db/data/**
-.hyphadb/config.yaml
-hypha
-.hypha/
+.preendb/config.yaml
+preen
+.preen/

LICENSE

@@ -1,9 +1,9 @@
-Copyright (c) 2024 Hypha Inc.
+Copyright (c) 2024 Preen Inc.
 
 Portions of this software are licensed as follows:
 
 * All content that resides under the "enterprise/" directory of this repository, if that directory exists, is licensed under the license defined in "enterprise/LICENSE.md".
-* All third party components incorporated into the Hypha Software are licensed under the original license provided by the owner of the applicable component.
+* All third party components incorporated into the Preen Software are licensed under the original license provided by the owner of the applicable component.
 * Content outside of the above mentioned directories or restrictions above is available under the "LGPL3" license as defined below.
 
 GNU LESSER GENERAL PUBLIC LICENSE

Makefile

@@ -4,7 +4,7 @@ integration-test: build
 
 .PHONY: build
 build:
-go build -o bin/hypha main.go
+go build -o bin/preen main.go
 
 .PHONY: lint
 lint:

README.md

@@ -1,10 +1,10 @@
-![tests](https://github.com/hyphasql/hypha/actions/workflows/ci.yaml/badge.svg)
+![tests](https://github.com/preendata/preen/actions/workflows/ci.yaml/badge.svg)
 
-# Hypha
+# Preen
 
-Hypha is a powerful command-line application for querying from multiple sources locally from your laptop. Under the hood, Hypha uses [DuckDB](https://duckdb.org/) to build an ephemeral, in-memory data warehouse and then uses DuckDB's SQL engine to query the data. Think of Hypha as a mix of Fivetran and DBT for your DuckDB use cases. You describe the data you want to query using a declarative language and Hypha takes care of the rest.
+Preen is a powerful command-line application for querying from multiple sources locally from your laptop. Under the hood, Preen uses [DuckDB](https://duckdb.org/) to build an ephemeral, in-memory data warehouse and then uses DuckDB's SQL engine to query the data. Think of Preen as a mix of Fivetran and DBT for your DuckDB use cases. You describe the data you want to query using a declarative language and Preen takes care of the rest.
 
-Hypha is currently in the alpha stage and not all features are available. We are working on adding more features and improving the user experience. If you have any questions or feedback, please feel free to open an issue on GitHub.
+Preen is currently in the alpha stage and not all features are available. We are working on adding more features and improving the user experience. If you have any questions or feedback, please feel free to open an issue on GitHub.
 
 ## Features
 
@@ -20,31 +20,31 @@ Hypha is currently in the alpha stage and not all features are available. We are
 
 ### Download pre-built binary
 
-You can download a pre-built binary for your operating system and architecture from the [GitHub Releases](https://github.com/hyphasql/hypha/releases) page.
+You can download a pre-built binary for your operating system and architecture from the [GitHub Releases](https://github.com/preendata/preen/releases) page.
 
 ```bash
 # Using curl
-sh -c "$(curl -fsSL https://raw.githubusercontent.com/hyphasql/hypha/main/build/install.sh)"
+sh -c "$(curl -fsSL https://raw.githubusercontent.com/preendata/preen/main/build/install.sh)"
 
 # Using wget
-sh -c "$(wget https://raw.githubusercontent.com/hyphasql/hypha/main/build/install.sh -O -)"
+sh -c "$(wget https://raw.githubusercontent.com/preendata/preen/main/build/install.sh -O -)"
 ```
 
 ### Build from source
 
-To build Hypha from source, you need to have Go 1.23.0 or later installed on your system. Then, you can build the application using the following commands:
+To build Preen from source, you need to have Go 1.23.0 or later installed on your system. Then, you can build the application using the following commands:
 
 ```bash
-git clone https://github.com/hyphasql/hypha.git
-cd hypha
+git clone https://github.com/preendata/preen.git
+cd preen
 make build
 ```
 
-This will create a `hypha` binary in the `bin` directory. You can add this to your `PATH` if you want to use the `hypha` command from anywhere.
+This will create a `preen` binary in the `bin` directory. You can add this to your `PATH` if you want to use the `preen` command from anywhere.
 
 ## Configuration
 
-Hypha uses two configuration files: `sources.yaml` and `models.yaml`. The `sources.yaml` file is used to configure the data sources that Hypha will query. The `models.yaml` file is used to define the models that Hypha will build. The directory Hypha will look for source and model configurations is configurable via the `HYPHA_CONFIG_PATH` environment variable. You can see an example of the environment configuation in the [.env.example](.env.example) file.The `models.yaml` file is optional. If it is not present, Hypha will look for `.yaml` files in the `models` directory.
+Preen uses two configuration files: `sources.yaml` and `models.yaml`. The `sources.yaml` file is used to configure the data sources that Preen will query. The `models.yaml` file is used to define the models that Preen will build. The directory Preen will look for source and model configurations is configurable via the `PREEN_CONFIG_PATH` environment variable. You can see an example of the environment configuation in the [.env.example](.env.example) file.The `models.yaml` file is optional. If it is not present, Preen will look for `.yaml` files in the `models` directory.
 
 Here is an example `sources.yaml` file:
 
@@ -55,7 +55,7 @@ sources:
  connection:
  host: localhost
  port: 27117
- database: hypha
+ database: preen
  username: root
  password: ${MONGO_PASSWORD} # You can also use environment variables.
  auth_source: admin
@@ -69,7 +69,7 @@ Here is an example `models.yaml` file:
 
 ```yaml
 models:
- - name: hypha-users-model
+ - name: preen-users-model
  type: database
  query: |
  SELECT users.user_id, users.name, users.email FROM users
@@ -78,7 +78,7 @@ models:
 You can validate your configuration by running:
 
 ```bash
-hypha source validate
+preen source validate
 ```
 
 ## Usage
@@ -88,24 +88,24 @@ hypha source validate
 Building a model will fetch the data from the source and save it to the DuckDB database. To build your models, run:
 
 ```bash
-hypha model build
+preen model build
 ```
 
 ### Querying Data
 
 You can query data using the interactive REPL. You can also specify the output format of the data (table, csv, markdown, json).
 
 ```bash
-hypha repl
+preen repl
 
 # Specify output format
-hypha repl --output-format csv
+preen repl --output-format csv
 ```
 
 For one-off queries, use the `query` command:
 
 ```bash
-hypha query "select * from your_model limit 10" --output-format csv
+preen query "select * from your_model limit 10" --output-format csv
 ```
 
 ## Development
@@ -121,4 +121,4 @@ To set up the development environment:
 
 ## License
 
-This project is dual-licensed under the LGPL-3.0 License and Hypha Enterprise License - see the [LICENSE](LICENSE) file for details. Our core features are free to use under the LGPL-3.0 License. If you need additional features, you can purchase a Hypha Enterprise License.
+This project is dual-licensed under the LGPL-3.0 License and Preen Enterprise License - see the [LICENSE](LICENSE) file for details. Our core features are free to use under the LGPL-3.0 License. If you need additional features, you can purchase a Preen Enterprise License.

build/ci/docker-compose.yaml

@@ -29,7 +29,7 @@ services:
  environment:
  - MONGO_INITDB_ROOT_USERNAME=root
  - MONGO_INITDB_ROOT_PASSWORD=thisisnotarealpassword
- - MONGO_INITDB_DATABASE=hypha
+ - MONGO_INITDB_DATABASE=preen
  volumes:
  - ./mongo/init-mongo.sh:/docker-entrypoint-initdb.d/init-mongo.sh
  - ./mongo/create-mongo-user.js:/scripts/create-mongo-user.js

build/ci/hyphadb.Dockerfile

@@ -1,7 +1,7 @@
 FROM golang:1.21.5-bullseye
 
-COPY . /hyphadb
+COPY . /preen
 
-WORKDIR /hyphadb
+WORKDIR /preen
 
 RUN go mod tidy

build/ci/integration-test.sh

@@ -3,24 +3,24 @@
 docker compose -f build/ci/docker-compose.yaml up -d
 sleep 5
 
-bin/hypha model build
+bin/preen model build
 
 # Test that the MySQL model was built and can be queried. Query should return 1 row.
-MYSQL_RESULTS_LENGTH=$(bin/hypha query -f json "select * from mysql_data_types_test;" | jq length)
+MYSQL_RESULTS_LENGTH=$(bin/preen query -f json "select * from mysql_data_types_test;" | jq length)
 if [[ $MYSQL_RESULTS_LENGTH -ne 1 ]]; then
  echo "Expected 1 row in mysql_data_types_test, got $MYSQL_RESULTS_LENGTH"
  exit 1
 fi
 
 # Test that the PostgreSQL model was built and can be queried. Query should return 1 row.
-PG_RESULTS_LENGTH=$(bin/hypha query -f json "select * from pg_data_types_test;" | jq length)
+PG_RESULTS_LENGTH=$(bin/preen query -f json "select * from pg_data_types_test;" | jq length)
 if [[ $PG_RESULTS_LENGTH -ne 1 ]]; then
  echo "Expected 1 row in pg_data_types_test, got $PG_RESULTS_LENGTH"
  exit 1
 fi
 
 # Test that the MongoDB model was built and can be queried. Query should return 1 row.
-MONGO_RESULTS_LENGTH=$(bin/hypha query -f json "select * from mongodb_test;" | jq length)
+MONGO_RESULTS_LENGTH=$(bin/preen query -f json "select * from mongodb_test;" | jq length)
 if [[ $MONGO_RESULTS_LENGTH -ne 1 ]]; then
  echo "Expected 1 row in mongodb_test, got $MONGO_RESULTS_LENGTH"
  exit 1