Merge branch 'main' into prompt-engine-api

.github/workflows/python-publish.yml

@@ -0,0 +1,32 @@
+name: Act on release created
+
+on:
+  release:
+    types: [published]
+
+jobs:
+    build-publish:
+
+      runs-on: ubuntu-latest
+
+      steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Install Poetry and version plugin
+        run: |
+          ls ./assets/scripts/gh-actions/
+          chmod +x ./assets/scripts/gh-actions/setup-poetry.sh
+          ./assets/scripts/gh-actions/setup-poetry.sh
+        shell: bash
+
+      - name: Build and publish
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          poetry config pypi-token.pypi $PYPI_TOKEN
+          poetry build
+          poetry publish

CONTRIBUTING.md

@@ -0,0 +1,107 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+## Types of Contributions
+
+**Report Bugs**
+
+Report bugs at [https://github.com/aiplanethub/genai-stack/issues](https://github.com/aiplanethub/genai-stack/issues).
+
+If you are reporting a bug, please include:
+
+-   Your operating system name and version.
+-   Any details about your local setup that might be helpful in troubleshooting.
+-   Detailed steps to reproduce the bug.
+
+**Fix Bugs**
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+**Implement Features**
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+**Write Documentation**
+
+GenAI Stack could always use more documentation, whether as part of the
+official GenAI Stack docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+**Submit Feedback**
+
+The best way to send feedback is to file an issue at [https://github.com/aiplanethub/genai-stack/issues](https://github.com/aiplanethub/genai-stack/issues).
+
+If you are proposing a feature:
+
+-   Explain in detail how it would work.
+-   Keep the scope as narrow as possible, to make it easier to implement.
+-   Remember that this is a volunteer-driven project, and that contributions
+    are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `genai_stack` for local development.
+
+1. Fork the `genai_stack` repo on GitHub.
+2. Clone your fork locally
+
+    ```bash
+    git clone [email protected]:your_name_here/genai_stack.git
+    ```
+
+3. Install Poetry for managing dependencies. If you haven't installed Poetry yet, follow the instructions at [https://python-poetry.org/docs/](https://python-poetry.org/docs/) to get it set up.
+
+4. Install your local copy into a virtualenv using Poetry::
+
+    ```bash
+    cd genai_stack/
+    poetry install
+    ```
+
+5. Create a branch for local development
+
+    ```bash
+    git checkout -b <name-of-your-bugfix-or-feature>
+    ```
+
+    Now you can make your changes locally.
+
+6. When you need to add or update a dependency, use Poetry. For example, to add a new dependency::
+
+    ```bash
+    poetry add <package-name>
+    ```
+
+    Or to update an existing dependency::
+
+    ```bash
+    poetry update <package-name>
+    ```
+
+7. When you're done making changes, check that your changes pass all the tests tests, including testing other Python versions.
+
+8. Commit your changes and push your branch to GitHub
+
+    ```bash
+    git add .
+    git commit -m "Your detailed description of your changes."
+    git push origin name-of-your-bugfix-or-feature
+    ```
+
+9. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+
+2. If the pull request adds functionality, the docs should be updated.
+
+3. The pull request should work for Python 3.8, 3.9, 3.10 and make sure that the tests pass for all supported Python versions in different platforms like Linux, Mac, Windows.

README.md

@@ -4,8 +4,8 @@
 
 <a href="https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10-3776AB.svg?style=flat&logo=python&logoColor=white"><img src="https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10-3776AB.svg?style=flat&logo=python&logoColor=white" alt="Python Versions"></a>
 <a href="https://discord.gg/4aWV7He2QU"><img src="https://dcbadge.vercel.app/api/server/4aWV7He2QU?style=flat" alt="Discord" /></a>
-<a href="https://twitter.com/aiplanet4all"><img src="https://img.shields.io/twitter/follow/aiplanet4all" alt="Twitter" /></a>
-<a href="https://colab.research.google.com/drive/1R-vnA0X5gTo_era8YChOvhFMVTVu7K-8?usp=sharing"><img src="https://camo.githubusercontent.com/84f0493939e0c4de4e6dbe113251b4bfb5353e57134ffd9fcab6b8714514d4d1/68747470733a2f2f636f6c61622e72657365617263682e676f6f676c652e636f6d2f6173736574732f636f6c61622d62616467652e737667" alt="Colab" /></a>
+<a href="https://twitter.com/aiplanethub"><img src="https://img.shields.io/twitter/follow/aiplanethub" alt="Twitter" /></a>
+<a href="https://colab.research.google.com/drive/1y6_0MoNWjS9wugv0askP1Jb7zrY_sQT-?usp=sharing"><img src="https://camo.githubusercontent.com/84f0493939e0c4de4e6dbe113251b4bfb5353e57134ffd9fcab6b8714514d4d1/68747470733a2f2f636f6c61622e72657365617263682e676f6f676c652e636f6d2f6173736574732f636f6c61622d62616467652e737667" alt="Colab" /></a>
 
 <p>GenAI Stack is an end-to-end framework for the integration of LLMs into any application. It can be deployed on your own infrastructure, ensuring data privacy. It comes with everything you need for data extraction, vector stores, to reliable model deployment.</p>
 <i><a href="https://discord.gg/4aWV7He2QU">👉 Join our Discord community!</a></i>
@@ -15,10 +15,16 @@
 
 Try out a quick demo of GenAI Stack on Google Colab:
 
-[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1R-vnA0X5gTo_era8YChOvhFMVTVu7K-8?usp=sharing)
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1y6_0MoNWjS9wugv0askP1Jb7zrY_sQT-?usp=sharing)
 
 ## Quick install
 
+```bash
+pip install genai_stack
+```
+
+OR
+
 ```bash
 pip install git+https://github.com/aiplanethub/genai-stack.git
 ```
@@ -28,7 +34,7 @@ pip install git+https://github.com/aiplanethub/genai-stack.git
 The documentation for GenAI Stack can be found at [genaistack.aiplanet.com](https://genaistack.aiplanet.com).
 
 ## GenAI Stack Workflow
-![GenAI Stack Workflow](./assets/workflow.png)
+![GenAI Stack Workflow](https://github.com/aiplanethub/genai-stack/blob/main/assets/workflow.png)
 
 
 ## What is GenAI Stack all about?
@@ -57,7 +63,7 @@ In short, it orchestrates and streamlines your Generative AI development journey
 
 GenAI Stack thrives in the rapidly evolving landscape of open-source projects. We wholeheartedly welcome contributions in various capacities, be it through innovative features, enhanced infrastructure, or refined documentation.
 
-For a comprehensive guide on the contribution process, please click [here](https://app.gitbook.com/o/-Mg1afEUq3HypLm46Vbq/s/fWJ1RLdoXjMtPiYoXUMB/getting-started/installation).
+For a comprehensive guide on the contribution process, please click [here](https://github.com/aiplanethub/genai-stack/blob/main/CONTRIBUTING.md).
 
 ## Acknowledgements
 

assets/scripts/gh-actions/setup-poetry.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+pip install poetry
+
+echo "Installing Poetry Version Plugin"
+pip install poetry-version-plugin
+
+poetry self show plugins