OASIS Refactor: First Release on PyPI

README.md

@@ -106,55 +106,97 @@ For more showcaes:
 
 ## ⚙️ Quick Start
 
-### 1. Clone the Repository
+1. **Install the OASIS package:**
+
+Installing OASIS is a breeze thanks to its availability on PyPI. Simply open your terminal and run:
+
+```bash
+pip install camel-oasis
+```
+
+2. **Set up your OpenAI API key:**
 
 ```bash
-git clone https://github.com/camel-ai/oasis.git
+# For Bash shell (Linux, macOS, Git Bash on Windows):
+export OPENAI_API_KEY=<insert your OpenAI API key>
 
-cd oasis
+# For Windows Command Prompt:
+set OPENAI_API_KEY=<insert your OpenAI API key>
 ```
 
-### 2. Create and Activate a Virtual Environment
+3. **Prepare the agent profile file:**
 
-Please choose one of the following methods to set up your environment. You only need to follow one of these methods.
+Create the profile you want to assign to the agent. As an example, you can download [user_data_36.json](https://github.com/camel-ai/oasis/blob/main/data/reddit/user_data_36.json) and place it in your local `./data/reddit` folder.
 
-- Option 1: Using Conda (Linux & macOS & windows)
+4. **Run the following Python code:**
 
-```bash
-conda create --name oasis python=3.10
-conda activate oasis
-```
+```python
+import asyncio
+import os
 
-- Option 2: Using venv (Linux & macOS)
+from camel.models import ModelFactory
+from camel.types import ModelPlatformType, ModelType
 
-```bash
-python -m venv oasis-venv
-source oasis-venv/bin/activate
-```
+import oasis
+from oasis import ActionType, EnvAction, SingleAction
 
-- Option 3: Using venv (Windows)
 
-```bash
-python -m venv oasis-venv
-oasis-venv\Scripts\activate
-```
+async def main():
+  # Define the model for the agents
+  openai_model = ModelFactory.create(
+      model_platform=ModelPlatformType.OPENAI,
+      model_type=ModelType.GPT_4O_MINI,
+  )
 
-### 3. Install Necessary Packages
+  # Define the available actions for the agents
+  available_actions = [
+      ActionType.LIKE_POST,
+      ActionType.CREATE_POST,
+      ActionType.CREATE_COMMENT,
+      ActionType.FOLLOW
+  ]
 
-```bash
-pip install --upgrade pip setuptools
+  # Make the environment
+  env = oasis.make(
+      platform=oasis.DefaultPlatformType.REDDIT,
+      database_path="reddit_simulation.db",
+      agent_profile_path="./data/reddit/user_data_36.json",
+      agent_models=openai_model,
+      available_actions=available_actions,
+  )
+
+  # Run the environment
+  await env.reset()
+
+  action = SingleAction(
+    agent_id=0,
+    action=ActionType.CREATE_POST,
+    args={"content": "Welcome to the OASIS World!"}
+  )
+
+  env_actions = EnvAction(
+    activate_agents=list(range(10)),  # activate the first 10 agents
+    intervention=[action]
+  )
+
+  # Apply interventions to the environment, refresh the recommendation system, and LLM agent perform actions
+  await env.step(env_actions)
+
+  # Close the environment
+  await env.close()
 
-pip install -e .  # This will install dependencies as specified in pyproject.toml
+if __name__ == "__main__":
+  asyncio.run(main())
 ```
 
 <br>
 
 > \[!TIP\]
-> For more detailed instructions and additional configuration options, check out the [installation section](tutorials/installation.md).
+> For more detailed instructions and additional configuration options, check out the documentation(coming soon).
 
 ### More Tutorials
 
-To discover how to create profiles for large-scale users, as well as how to visualize and analyze social simulation data once your experiment concludes, please refer to [More Tutorials](tutorials/tutorial.md) for detailed guidance.
+To discover how to create profiles for large-scale users, as well as how to visualize and analyze social simulation data once your experiment concludes, please refer to [More Tutorials](examples/experiment/user_generation_visualization.md) for detailed guidance.
 
 <div align="center">
   <img src="assets/tutorial.png" alt="Tutorial Overview">

docs/README.md

@@ -0,0 +1,32 @@
+# Mintlify Starter Kit
+
+Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
+
+- Guide pages
+- Navigation
+- Customizations
+- API Reference pages
+- Use of popular components
+
+### Development
+
+Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
+
+```
+npm i -g mintlify
+```
+
+Run the following command at the root of your documentation (where docs.json is)
+
+```
+mintlify dev
+```
+
+### Publishing Changes
+
+Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
+
+#### Troubleshooting
+
+- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
+- Page loads as a 404 - Make sure you are running in a folder with `docs.json`

docs/api-reference/endpoint/create.mdx

@@ -0,0 +1,4 @@
+---
+title: 'Create Plant'
+openapi: 'POST /plants'
+---

docs/api-reference/endpoint/delete.mdx

@@ -0,0 +1,4 @@
+---
+title: 'Delete Plant'
+openapi: 'DELETE /plants/{id}'
+---

docs/api-reference/endpoint/get.mdx

@@ -0,0 +1,4 @@
+---
+title: 'Get Plants'
+openapi: 'GET /plants'
+---

docs/api-reference/endpoint/webhook.mdx

@@ -0,0 +1,4 @@
+---
+title: 'New Plant'
+openapi: 'WEBHOOK /plant/webhook'
+---

docs/api-reference/introduction.mdx

@@ -0,0 +1,33 @@
+---
+title: 'Introduction'
+description: 'Example section for showcasing API endpoints'
+---
+
+<Note>
+  If you're not looking to build API reference documentation, you can delete
+  this section by removing the api-reference folder.
+</Note>
+
+## Welcome
+
+There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification.
+
+<Card
+  title="Plant Store Endpoints"
+  icon="leaf"
+  href="https://github.com/mintlify/starter/blob/main/api-reference/openapi.json"
+>
+  View the OpenAPI specification file
+</Card>
+
+## Authentication
+
+All API endpoints are authenticated using Bearer tokens and picked up from the specification file.
+
+```json
+"security": [
+  {
+    "bearerAuth": []
+  }
+]
+```