ingestr 0.10.2__tar.gz → 0.10.3__tar.gz

ingestr-0.10.3/.githooks/pre-commit-hook.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+echo "scanning for secrets ..."
+
+WORK_DIR="/root/code"
+
+secret_detected() {
+    echo "secrets detected in source code. commit aborted."
+    exit 1
+}
+
+# use gitleaks binary if available
+# else fallback to using docker for running gitleaks
+CMD="gitleaks dir -v"
+
+if [[ ! `which gitleaks`  ]]; then
+    which docker > /dev/null || (echo "gitleaks or docker is required for running secrets scan." && exit 1)
+    CMD="docker run -v $PWD:$WORK_DIR -w $WORK_DIR ghcr.io/gitleaks/gitleaks:latest dir -v"
+fi
+
+$CMD || secret_detected

ingestr-0.10.3/.github/workflows/secrets-scan.yml

@@ -0,0 +1,12 @@
+name: secrets_scan
+on: [pull_request, push, workflow_dispatch]
+jobs:
+  scan:
+    name: gitleaks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: scan for secrets (gitleaks)
+        run: docker run -v $PWD:/code -w /code ghcr.io/gitleaks/gitleaks:latest dir -v

ingestr-0.10.3/.gitleaksignore

@@ -0,0 +1,3 @@
+ingestr/src/telemetry/event.py:generic-api-key:9
+ingestr/src/testdata/fakebqcredentials.json:private-key:5
+docs/supported-sources/shopify.md:generic-api-key:26

{ingestr-0.10.2 → ingestr-0.10.3}/Makefile

@@ -1,11 +1,11 @@
 .ONESHELL:
-.PHONY: test lint format ftl test-ci lint-ci build upload-release
+.PHONY: test lint format test-ci lint-ci build upload-release setup
 
 venv: venv/touchfile
 
 venv/touchfile: requirements-dev.txt requirements.txt
 	test -d venv || python3 -m venv venv
-	. venv/bin/activate; $(MAKE) deps
+	. venv/bin/activate; pip install uv; $(MAKE) deps
 	touch venv/touchfile
 
 deps:
@@ -40,3 +40,7 @@ build:
 
 upload-release:
 	twine upload --verbose dist/*
+
+setup:
+	@echo "installing git hooks ..."
+	@install -m 755 .githooks/pre-commit-hook.sh .git/hooks/pre-commit

{ingestr-0.10.2 → ingestr-0.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ingestr
-Version: 0.10.2
+Version: 0.10.3
 Summary: ingestr is a command-line application that ingests data from various sources and stores them in any database.
 Project-URL: Homepage, https://github.com/bruin-data/ingestr
 Project-URL: Issues, https://github.com/bruin-data/ingestr/issues
@@ -74,11 +74,20 @@ ingestr is a command-line app that allows you to ingest data from any source int
 ingestr takes away the complexity of managing any backend or writing any code for ingesting data, simply run the command and watch the data land on its destination.
 
 ## Installation
+We recommend using [uv](https://github.com/astral-sh/uv) to run `ingestr`.
 
 ```
-pip install ingestr
+pip install uv
+uvx ingestr
 ```
 
+Alternatively, if you'd like to install it globally:
+```
+uv pip install --system ingestr
+```
+
+While installation with vanilla `pip` is possible, it's an order of magnitude slower.
+
 ## Quickstart
 
 ```bash
@@ -104,6 +113,13 @@ You can see the full documentation [here](https://bruin-data.github.io/ingestr/g
 
 Join our Slack community [here](https://join.slack.com/t/bruindatacommunity/shared_invite/zt-2dl2i8foy-bVsuMUauHeN9M2laVm3ZVg).
 
+## Contributing
+
+Pull requests are welcome. However, please open an issue first to discuss what you would like to change. We maybe able to offer you help and feedback regarding any changes you would like to make.
+
+> [!NOTE]
+> After cloning `ingestr` make sure to run `make setup` to install githooks.
+
 ## Supported sources & destinations
 
 <table>

{ingestr-0.10.2 → ingestr-0.10.3}/README.md

@@ -21,11 +21,20 @@ ingestr is a command-line app that allows you to ingest data from any source int
 ingestr takes away the complexity of managing any backend or writing any code for ingesting data, simply run the command and watch the data land on its destination.
 
 ## Installation
+We recommend using [uv](https://github.com/astral-sh/uv) to run `ingestr`.
 
 ```
-pip install ingestr
+pip install uv
+uvx ingestr
 ```
 
+Alternatively, if you'd like to install it globally:
+```
+uv pip install --system ingestr
+```
+
+While installation with vanilla `pip` is possible, it's an order of magnitude slower.
+
 ## Quickstart
 
 ```bash
@@ -51,6 +60,13 @@ You can see the full documentation [here](https://bruin-data.github.io/ingestr/g
 
 Join our Slack community [here](https://join.slack.com/t/bruindatacommunity/shared_invite/zt-2dl2i8foy-bVsuMUauHeN9M2laVm3ZVg).
 
+## Contributing
+
+Pull requests are welcome. However, please open an issue first to discuss what you would like to change. We maybe able to offer you help and feedback regarding any changes you would like to make.
+
+> [!NOTE]
+> After cloning `ingestr` make sure to run `make setup` to install githooks.
+
 ## Supported sources & destinations
 
 <table>

{ingestr-0.10.2 → ingestr-0.10.3}/docs/getting-started/quickstart.md

@@ -13,9 +13,19 @@ ingestr takes away the complexity of managing any backend or writing any code fo
 
 
 ## Installation
+We recommend using [uv](https://github.com/astral-sh/uv) to run `ingestr`.
+
+```
+pip install uv
+uvx ingestr
 ```
-pip install ingestr
+
+Alternatively, if you'd like to install it globally:
 ```
+uv pip install --system ingestr
+```
+
+While installation with vanilla `pip` is possible, it's an order of magnitude slower.
 
 ## Quickstart
 

{ingestr-0.10.2 → ingestr-0.10.3}/ingestr/main.py

@@ -288,6 +288,8 @@ def ingest(
         ),
     ] = [],  # type: ignore
 ):
+
+    # TODO(turtledev): can't we move this to the top of this file?
     import hashlib
     import tempfile
     from datetime import datetime
@@ -383,6 +385,15 @@ def ingest(
         )
 
         factory = SourceDestinationFactory(source_uri, dest_uri)
+        track(
+            "command_running", 
+            {
+                "command": "ingest",
+                "source_type": factory.source_scheme,
+                "destination_type": factory.destination_scheme,
+            },
+        )
+
         source = factory.get_source()
         destination = factory.get_destination()
 

ingestr-0.10.3/ingestr/src/version.py

@@ -0,0 +1 @@
+__version__ = "0.10.3"

ingestr-0.10.2/ingestr/src/version.py

@@ -1 +0,0 @@
-__version__ = "0.10.2"