Move getting started & .env to each project (#20)

Changed my mind, I think it makes more sense for each example to have a self contained README instead of asking people to go look at the main README first. Also makes it easier to link directly to an example
autoblocksai · Oct 26, 2023 · 0843e47 · 0843e47 · vercel · Oct 26, 2023
1 parent b70185c
commit 0843e47
Show file tree

Hide file tree

Showing 18 changed files with 169 additions and 84 deletions.
diff --git a/.env.example b/.env.example
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,7 +13,7 @@ on:
     - cron: "17 12 * * *"
 
 jobs:
-  test-table-of-contents-up-to-date:
+  test-readmes-up-to-date:
     runs-on: ubuntu-latest
 
     steps:
@@ -25,16 +25,16 @@ jobs:
         with:
           node-version: 20
 
-      - name: Make table of contents
-        run: node tools/make-toc.js
+      - name: Make READMEs
+        run: node tools/make-readmes.js
 
-      - name: Ensure table of contents is up to date
+      - name: Ensure READMEs are up to date
         run: |
           if [[ -n $(git status --porcelain) ]]; then
-              echo "::error::The table of contents is out of date. Please run 'node tools/make-toc.js' and commit the changes."
+              echo "::error::The READMEs are out of date. Please run 'node tools/make-readmes.js' and commit the changes."
               exit 1
           else
-              echo "Table of contents is up to date!"
+              echo "READMEs are up to date!"
           fi
 
   test-python:
@@ -47,6 +47,11 @@ jobs:
           - Python/openai-manual
           - Python/openai-automated
 
+    defaults:
+      run:
+        shell: bash
+        working-directory: ${{ matrix.project }}
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -67,15 +72,12 @@ jobs:
 
       - name: Check pyproject.toml & poetry.lock are in sync
         run: poetry lock --check
-        working-directory: ${{ matrix.project }}
 
       - name: Install dependencies
         run: poetry install
-        working-directory: ${{ matrix.project }}
 
       - name: Run script
         run: poetry run python main.py
-        working-directory: ${{ matrix.project }}
 
   test-javascript:
     runs-on: ubuntu-latest
@@ -89,6 +91,11 @@ jobs:
           - JavaScript/openai-automated
           - JavaScript/openai-manual
 
+    defaults:
+      run:
+        shell: bash
+        working-directory: ${{ matrix.project }}
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -106,11 +113,9 @@ jobs:
 
       - name: Install dependencies
         run: npm ci
-        working-directory: ${{ matrix.project }}
 
       - name: Run script
         run: npm run start
-        working-directory: ${{ matrix.project }}
 
   notify:
     needs:

diff --git a/JavaScript/chatbot-nextjs/README.md b/JavaScript/chatbot-nextjs/README.md
@@ -17,22 +17,28 @@
   🏠
   <a href="https://www.autoblocks.ai/">Home</a>
 </p>
-<p align="center">
-  :bangbang:
-  Make sure you've read the <a href="/README.md#getting-started">getting started</a> section in the main README.
-</p>
 <!-- banner end -->
 
 # Chatbot Example
+
 This is a Next.js app that uses openai and Autoblocks to power and monitor a chatbot.
 
 View the deployed application at https://chatbot-example.autoblocks.ai
 
-## Copy the root `.env` file to this directory
+<!-- getting started start -->
+## Getting started
 
-```bash
-cp ../../.env .
+- Sign up for an Autoblocks account at https://app.autoblocks.ai
+- Grab your Autoblocks ingestion key from https://app.autoblocks.ai/settings/api-keys
+- Grab your OpenAI API key from https://platform.openai.com/account/api-keys
+- Create a file named `.env` in this folder and include the following environment variables:
+
+`.env`
+```
+OPENAI_API_KEY=<your-api-key>
+AUTOBLOCKS_INGESTION_KEY=<your-ingestion-key>
 ```
+<!-- getting started end -->
 
 ## Install dependencies
 

diff --git a/JavaScript/langchain/README.md b/JavaScript/langchain/README.md
@@ -17,12 +17,23 @@
   🏠
   <a href="https://www.autoblocks.ai/">Home</a>
 </p>
-<p align="center">
-  :bangbang:
-  Make sure you've read the <a href="/README.md#getting-started">getting started</a> section in the main README.
-</p>
 <!-- banner end -->
 
+<!-- getting started start -->
+## Getting started
+
+- Sign up for an Autoblocks account at https://app.autoblocks.ai
+- Grab your Autoblocks ingestion key from https://app.autoblocks.ai/settings/api-keys
+- Grab your OpenAI API key from https://platform.openai.com/account/api-keys
+- Create a file named `.env` in this folder and include the following environment variables:
+
+`.env`
+```
+OPENAI_API_KEY=<your-api-key>
+AUTOBLOCKS_INGESTION_KEY=<your-ingestion-key>
+```
+<!-- getting started end -->
+
 ## Install dependencies
 
 ```

diff --git a/JavaScript/langchain/package.json b/JavaScript/langchain/package.json
@@ -8,7 +8,7 @@
   },
   "type": "module",
   "scripts": {
-    "start": "dotenv -e ../../.env -- node ./src/index.js"
+    "start": "dotenv -e .env -- node ./src/index.js"
   },
   "author": "",
   "license": "MIT",

diff --git a/JavaScript/novel-ai-text-editor/README.md b/JavaScript/novel-ai-text-editor/README.md
@@ -17,21 +17,26 @@
   🏠
   <a href="https://www.autoblocks.ai/">Home</a>
 </p>
-<p align="center">
-  :bangbang:
-  Make sure you've read the <a href="/README.md#getting-started">getting started</a> section in the main README.
-</p>
 <!-- banner end -->
 
 # Novel Example
 
 Example Next.js application using [Novel](https://github.com/steven-tey/novel). Based on [novella](https://github.com/steven-tey/novella).
 
-## Copy the root `.env` file to this directory
+<!-- getting started start -->
+## Getting started
 
-```bash
-cp ../../.env .
+- Sign up for an Autoblocks account at https://app.autoblocks.ai
+- Grab your Autoblocks ingestion key from https://app.autoblocks.ai/settings/api-keys
+- Grab your OpenAI API key from https://platform.openai.com/account/api-keys
+- Create a file named `.env` in this folder and include the following environment variables:
+
+`.env`
+```
+OPENAI_API_KEY=<your-api-key>
+AUTOBLOCKS_INGESTION_KEY=<your-ingestion-key>
 ```
+<!-- getting started end -->
 
 ## Install Dependencies
 

diff --git a/JavaScript/openai-automated/README.md b/JavaScript/openai-automated/README.md
@@ -17,12 +17,23 @@
   🏠
   <a href="https://www.autoblocks.ai/">Home</a>
 </p>
-<p align="center">
-  :bangbang:
-  Make sure you've read the <a href="/README.md#getting-started">getting started</a> section in the main README.
-</p>
 <!-- banner end -->
 
+<!-- getting started start -->
+## Getting started
+
+- Sign up for an Autoblocks account at https://app.autoblocks.ai
+- Grab your Autoblocks ingestion key from https://app.autoblocks.ai/settings/api-keys
+- Grab your OpenAI API key from https://platform.openai.com/account/api-keys
+- Create a file named `.env` in this folder and include the following environment variables:
+
+`.env`
+```
+OPENAI_API_KEY=<your-api-key>
+AUTOBLOCKS_INGESTION_KEY=<your-ingestion-key>
+```
+<!-- getting started end -->
+
 ## Install Dependencies
 
 ```

diff --git a/JavaScript/openai-automated/package.json b/JavaScript/openai-automated/package.json
@@ -6,7 +6,7 @@
   "type": "module",
   "main": "src/index.js",
   "scripts": {
-    "start": "dotenv -e ../../.env -- node ./src/index.js"
+    "start": "dotenv -e .env -- node ./src/index.js"
   },
   "license": "MIT",
   "dependencies": {

diff --git a/JavaScript/openai-manual/README.md b/JavaScript/openai-manual/README.md
@@ -17,12 +17,23 @@
   🏠
   <a href="https://www.autoblocks.ai/">Home</a>
 </p>
-<p align="center">
-  :bangbang:
-  Make sure you've read the <a href="/README.md#getting-started">getting started</a> section in the main README.
-</p>
 <!-- banner end -->
 
+<!-- getting started start -->
+## Getting started
+
+- Sign up for an Autoblocks account at https://app.autoblocks.ai
+- Grab your Autoblocks ingestion key from https://app.autoblocks.ai/settings/api-keys
+- Grab your OpenAI API key from https://platform.openai.com/account/api-keys
+- Create a file named `.env` in this folder and include the following environment variables:
+
+`.env`
+```
+OPENAI_API_KEY=<your-api-key>
+AUTOBLOCKS_INGESTION_KEY=<your-ingestion-key>
+```
+<!-- getting started end -->
+
 ## Install Dependencies
 
 ```

diff --git a/JavaScript/openai-manual/package.json b/JavaScript/openai-manual/package.json
@@ -5,7 +5,7 @@
   "type": "module",
   "main": "src/index.js",
   "scripts": {
-    "start": "dotenv -e ../../.env -- node ./src/index.js"
+    "start": "dotenv -e .env -- node ./src/index.js"
   },
   "license": "MIT",
   "dependencies": {

diff --git a/Python/langchain/README.md b/Python/langchain/README.md
@@ -17,12 +17,23 @@
   🏠
   <a href="https://www.autoblocks.ai/">Home</a>
 </p>
-<p align="center">
-  :bangbang:
-  Make sure you've read the <a href="/README.md#getting-started">getting started</a> section in the main README.
-</p>
 <!-- banner end -->
 
+<!-- getting started start -->
+## Getting started
+
+- Sign up for an Autoblocks account at https://app.autoblocks.ai
+- Grab your Autoblocks ingestion key from https://app.autoblocks.ai/settings/api-keys
+- Grab your OpenAI API key from https://platform.openai.com/account/api-keys
+- Create a file named `.env` in this folder and include the following environment variables:
+
+`.env`
+```
+OPENAI_API_KEY=<your-api-key>
+AUTOBLOCKS_INGESTION_KEY=<your-ingestion-key>
+```
+<!-- getting started end -->
+
 ## Install dependencies
 
 ```bash

diff --git a/Python/langchain/main.py b/Python/langchain/main.py
@@ -5,7 +5,7 @@
 from langchain.llms import OpenAI
 from langchain.prompts import PromptTemplate
 
-dotenv.load_dotenv("../../.env")
+dotenv.load_dotenv(".env")
 
 
 if __name__ == "__main__":

diff --git a/Python/openai-automated/README.md b/Python/openai-automated/README.md
@@ -17,13 +17,24 @@
   🏠
   <a href="https://www.autoblocks.ai/">Home</a>
 </p>
-<p align="center">
-  :bangbang:
-  Make sure you've read the <a href="/README.md#getting-started">getting started</a> section in the main README.
-</p>
 <!-- banner end -->
 
-## Install dependencies:
+<!-- getting started start -->
+## Getting started
+
+- Sign up for an Autoblocks account at https://app.autoblocks.ai
+- Grab your Autoblocks ingestion key from https://app.autoblocks.ai/settings/api-keys
+- Grab your OpenAI API key from https://platform.openai.com/account/api-keys
+- Create a file named `.env` in this folder and include the following environment variables:
+
+`.env`
+```
+OPENAI_API_KEY=<your-api-key>
+AUTOBLOCKS_INGESTION_KEY=<your-ingestion-key>
+```
+<!-- getting started end -->
+
+## Install dependencies
 
 ```bash
 poetry install

diff --git a/Python/openai-automated/main.py b/Python/openai-automated/main.py
@@ -2,7 +2,7 @@
 
 # Environment variables need to be loaded before we import
 # trace_openai and openai
-dotenv.load_dotenv("../../.env")
+dotenv.load_dotenv(".env")
 
 from autoblocks.vendor.openai import trace_openai
 import openai

diff --git a/Python/openai-manual/README.md b/Python/openai-manual/README.md
@@ -17,13 +17,24 @@
   🏠
   <a href="https://www.autoblocks.ai/">Home</a>
 </p>
-<p align="center">
-  :bangbang:
-  Make sure you've read the <a href="/README.md#getting-started">getting started</a> section in the main README.
-</p>
 <!-- banner end -->
 
-## Install dependencies:
+<!-- getting started start -->
+## Getting started
+
+- Sign up for an Autoblocks account at https://app.autoblocks.ai
+- Grab your Autoblocks ingestion key from https://app.autoblocks.ai/settings/api-keys
+- Grab your OpenAI API key from https://platform.openai.com/account/api-keys
+- Create a file named `.env` in this folder and include the following environment variables:
+
+`.env`
+```
+OPENAI_API_KEY=<your-api-key>
+AUTOBLOCKS_INGESTION_KEY=<your-ingestion-key>
+```
+<!-- getting started end -->
+
+## Install dependencies
 
 ```bash
 poetry install

diff --git a/Python/openai-manual/main.py b/Python/openai-manual/main.py
@@ -7,7 +7,7 @@
 import openai
 from autoblocks.tracer import AutoblocksTracer
 
-dotenv.load_dotenv("../../.env")
+dotenv.load_dotenv(".env")
 
 openai.api_key = os.environ["OPENAI_API_KEY"]