surazgaundel · tulavamsidheeraj · Jul 30, 2023 · Jul 30, 2023 · Jul 30, 2023 · Jul 30, 2023
diff --git a/.env.example b/.env.example
diff --git a/.gitignore b/.gitignore
@@ -14,7 +14,6 @@ __pycache__/
 .Python
 build/
 develop-eggs/
-# dist/
 downloads/
 eggs/
 .eggs/
@@ -30,6 +29,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+dist
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -88,13 +88,6 @@ ipython_config.py
 # pyenv
 .python-version
 
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow
 __pypackages__/
 
@@ -114,6 +107,7 @@ ENV/
 env.bak/
 venv.bak/
 cpcli-env/
+/poetry.lock
 
 # Spyder project settings
 .spyderproject

diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,20 @@
+## Scope
+`[Add context about what this feature is about and explain why of the feature and your technical decisions.]`
+
+
+
+- [ ] `[Sub task]`
+
+
+### Screenshots
+---
+
+
+## Code improvements
+- `[Did you add some generic like utility, component, or anything else useful outside of this PR]`
+
+
+### Developer checklist
+- [ ] I’ve manually tested that code works locally on desktop and mobile browsers.
+- [ ] I’ve reviewed my code.
+- [ ] I’ve removed all my personal credentials (API keys etc.) from the code.
diff --git a/README.md b/README.md
@@ -1,25 +1,53 @@
-# Textbase
-
-✨ Textbase is a framework for building chatbots using NLP and ML. ✨
+<p align="center">
+  <picture>
+    <img alt="Textbase python library" src="assets/logo.svg" width="352" height="59" style="max-width: 100%;">
+  </picture>
+  <br/>
+  <br/>
+</p>
+
+<p align="center">
+    <a href="https://docs.textbase.ai">
+        <img alt="Documentation" src="https://img.shields.io/website/http/huggingface.co/docs/transformers/index.svg?down_color=red&down_message=offline&up_message=online">
+    </a>
+</p>
+
+<h3 align="center">
+    <p>✨ Textbase is a framework for building chatbots using NLP and ML. ✨</p>
+</h3>
+
+<h3 align="center">
+    <a href="https://textbase.ai"><img src="assets/banner.png"></a>
+</h3>
 
 Just implement the `on_message` function in `main.py` and Textbase will take care of the rest :)
 
 Since it is just Python you can use whatever models, libraries, vector databases and APIs you want.
 
-_Coming soon:_
-
-- [ ] PyPI package
+Coming soon:
+- [x] [PyPI package](https://pypi.org/project/textbase-client/)
+- [x] Easy web deployment via [textbase deploy](/docs/deployment/deploy-from-cli)
 - [ ] SMS integration
-- [ ] Easy web deployment via `textbase deploy`
 - [ ] Native integration of other models (Claude, Llama, ...)
 
+![Demo Deploy GIF](assets/textbase-deploy.gif)
+
 ## Installation
+Make sure you have `python version >=3.9.0`, it's always good to follow the [docs](https://docs.textbase.ai/get-started/installation) 👈🏻
+### 1. Through pip
+```bash
+pip install textbase-client
+```
 
+### 2. Local installation
 Clone the repository and install the dependencies using [Poetry](https://python-poetry.org/) (you might have to [install Poetry](https://python-poetry.org/docs/#installation) first).
 
+For proper details see [here]()
+
 ```bash
 git clone https://github.com/cofactoryai/textbase
 cd textbase
+poetry shell
 poetry install
 ```
 
@@ -28,15 +56,24 @@ poetry install
 > If you're using the default template, **remember to set the OpenAI API key** in `main.py`.
 
 Run the following command:
-
+- if installed locally
+    ```bash
+    poetry run python textbase/textbase_cli.py test
+    ```
+- if installed through pip
+    ```bash
+    textbase-client test
+    ```
+Response:
 ```bash
-poetry run python textbase/textbase_cli.py test main.py
+Path to the main.py file: examples/openai-bot/main.py # You can create a main.py by yourself and add that path here. NOTE: The path should not be in quotes
 ```
+Now go to the link in blue color which is shown on the CLI and you will be able to chat with your bot!
+![Local UI](assets/test_command.png)
 
-Now go to [http://localhost:4000](http://localhost:4000) and start chatting with your bot! The bot will automatically reload when you change the code.
+### `Other commands have been mentioned in the documentaion website.` [Have a look](https://docs.textbase.ai/usage) 😃!
 
-_Simpler version using PyPI package and CLI coming soon!_
 
 ## Contributions
 
-Contributions are welcome! Please open an issue or a pull request.
+Contributions are welcome! Please open an issue or create a pull request.
diff --git a/assets/banner.png b/assets/banner.png
diff --git a/assets/logo.svg b/assets/logo.svg
diff --git a/assets/test_command.png b/assets/test_command.png
diff --git a/assets/textbase-deploy.gif b/assets/textbase-deploy.gif
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/docs/assets/library_server.gif b/docs/assets/library_server.gif
diff --git a/docs/assets/local_server.gif b/docs/assets/local_server.gif
diff --git a/docs/assets/mac_zip.png b/docs/assets/mac_zip.png
diff --git a/docs/assets/select_interpreter.gif b/docs/assets/select_interpreter.gif
diff --git a/docs/assets/zipping.gif b/docs/assets/zipping.gif
diff --git a/docs/babel.config.js b/docs/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/docs/docs/FAQs.md b/docs/docs/FAQs.md
@@ -0,0 +1,14 @@
+---
+sidebar_position: 6
+---
+
+### Why is my bot deploy failing even though I have followed the correct folder structure?
+Make sure that you have an `on_message` function inside your `main.py` file and you also have the `bot()` decorator.
+
+If you are a MacOS user, make sure that you use the website which we have provided in the [prerequisites](./deployment/prerequisites.md#important-note-for-macos-users) section to zip your files.
+
+### Why am I getting a weird axios error when I am trying to deploy my bot using the CLI?
+We currently have a two bot limit per user. If you have exceeded that, then you will get this error in the CLI.
+
+### Why am I getting an Error: Got unexpected extra argument?
+This is because your path has a space in between somewhere and it's considering whatever's there after the space as an entirely extra argument. Check your path and make sure that there are no spaces in between.
diff --git a/docs/docs/deployment/_category_.json b/docs/docs/deployment/_category_.json
@@ -0,0 +1,7 @@
+{
+  "label": "Deployment",
+  "position": 4,
+  "link": {
+    "type": "generated-index"
+  }
+}
diff --git a/docs/docs/deployment/deploy-from-cli.md b/docs/docs/deployment/deploy-from-cli.md
@@ -0,0 +1,30 @@
+---
+sidebar_position: 2
+---
+
+# Deploy from CLI
+
+## API key generation
+
+Before deploying your bot from the CLI, you need to generate an API key in the dashboard. To do that, you need to:
+
+1. Navigate to the Textbase [dashboard](https://textbase-dashboard-nextjs.vercel.app/).
+2. Sign in using your google account.
+3. Generate an API key by clicking on `Generate` in the bottom left section.
+
+## Deployment
+
+After this, you can execute the `textbase-client deploy` command to deploy your bot from a terminal.
+
+After executing it, it will ask for:
+1. Path to the zip folder
+2. Bot name (**IMPORTANT:** can only contain lowercase alphanumeric characters, hyphens, and underscores)
+3. Textbase API key
+
+If you want to run this command in one shot, you can make use of flags:
+
+```bash
+textbase-client deploy --path=<path_to_zip_folder> --bot-name=<name_of_your_bot> --api_key=<api_key>
+```
+
+If this command executes successfully, it will return a table with `Status`, `Bot ID` and `URL` and you can click on that URL to view your bot!
diff --git a/docs/docs/deployment/deploy-from-dashboard.md b/docs/docs/deployment/deploy-from-dashboard.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 3
+---
+
+# Deploy from Dashboard
+
+1. Navigate to the Textbase [dashboard](https://textbase-dashboard-nextjs.vercel.app/).
+2. Sign in using your google account.
+3. Click on `Create Deployment` and then click on `Create Bot` on the top right.
+4. You will need to provide a chatbot name and you need to upload the zip file. **IMPORTANT:** The bot name can only contain lowercase alphanumeric characters, hyphens, and underscores.
+5. Click on `Create Bot` to start the deployment.
+6. This will redirect you to the `Deployments` section after a few seconds. In here, you can check the status of your bot and if it's deployed successfully, a link will be generated. You can click on the blue button with the symbol: `</>` which will redirect to the link where the bot is deployed and you can test it out!
diff --git a/docs/docs/deployment/prerequisites.md b/docs/docs/deployment/prerequisites.md
@@ -0,0 +1,52 @@
+---
+sidebar_position: 1
+---
+
+# Prerequisites
+There are two methods to deploy your bot to the internet so that everyone can use it.
+
+Before using any method, you need to ensure that:
+1. You have a `requirements.txt` file which includes all the additional requirements which you might have installed while coding up the logic for your bot.
+2. The name of the file in which the `on_message` function is present is named `main.py`.
+3. You can have your own packages and modules in different folders and have relative imports to them. But the `main.py` and `requirements.txt` must **ABSOLUTELY NOT** be in any folder of their own.
+3. Zip these two (or more) files into a `.zip` archive. It's important that it's a **.zip** archive and not anything else. If you are using MacOS, please read the note below.
+
+## Important note for MacOS users
+Please download the software `RAR Extractor MAX` from App Store ![Mac Zip Software](../../assets/mac_zip.png) for creating archives as MacOS creates an extra `__MACOSX` folder when compressing using the native compress utility which causes some issues with our backend.
+
+
+## Folder structure
+When you decide to archive the files, please **MAKE SURE** that main.py and requirements.txt are available in the **root** of the archive itself. As in if the zip is extracted, it will produce two (or more) files/folders.
+
+![Zip folder](../../assets/zipping.gif)
+
+### Good folder structure :white_check_mark:
+```
+your-bot.zip/
+├── main.py
+├── requirements.txt
+└── your_package/
+    └── your_module/
+        └── sub_module
+```
+### Bad folder structure 1 :x:
+```
+your-bot.zip/
+└── bot_folder/
+    ├── main.py
+    ├── requirements.txt
+    └── your_package/
+        └── your_module/
+            └── sub_module
+```
+
+### Bad folder structure 2 :x:
+```
+your-bot.zip/
+├── main_folder/
+│   ├── main.py
+│   └── requirements.txt
+└── your_package/
+    └── your_module/
+        └── sub_module
+```
diff --git a/docs/docs/examples/_category_.json b/docs/docs/examples/_category_.json
@@ -0,0 +1,7 @@
+{
+  "label": "Examples",
+  "position": 5,
+  "link": {
+    "type": "generated-index"
+  }
+}