From 7f8f3d02b5acf967593bbd7275fb641c5a4887dd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20Schr=C3=B6der?=
<fschroeder@techfak.uni-bielefeld.de>
Date: Wed, 28 Feb 2024 16:53:04 +0100
Subject: [PATCH] Update import statements in documentation
The import statements in the README and __init__.py needed adjustments due to renaming of 'overcooked_environment' to 'environment'. This commit updates the relevant parts in the documentation to prevent any confusion for users of the 'cooperative_cuisine' package.
---
README.md | 2 +-
cooperative_cuisine/__init__.py | 6 +++---
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 4b82d711..1bddb49c 100644
--- a/README.md
+++ b/README.md
@@ -59,7 +59,7 @@ pip install overcooked-environment@git+https://gitlab.ub.uni-bielefeld.de/scs/co
#### Run
You can now use the environment and/or simulator in your python code. Just by importing
-it `import overcooked_environment`
+it `import cooperative_cuisine`
## Configuration
diff --git a/cooperative_cuisine/__init__.py b/cooperative_cuisine/__init__.py
index fe15de74..5192eeae 100644
--- a/cooperative_cuisine/__init__.py
+++ b/cooperative_cuisine/__init__.py
@@ -94,7 +94,7 @@ import json
import dataclasses
from websockets import connect
-from cooperative_cuisine.overcooked_environment import Action, ActionType, InterActionData
+from cooperative_cuisine.environment import Action, ActionType, InterActionData
from cooperative_cuisine.utils import custom_asdict_factory
@@ -154,14 +154,14 @@ requests.post(
```
## Direct integration into your code
-You can use the `cooperative_cuisine.overcooked_environment.Environment` class
+You can use the `cooperative_cuisine.environment.Environment` class
and call the `step`, `get_json_state`, and `perform_action` methods directly.
```python
from datetime import timedelta
from cooperative_cuisine import ROOT_DIR
-from cooperative_cuisine.overcooked_environment import Action, Environment
+from cooperative_cuisine.environment import Action, Environment
env = Environment(
env_config=ROOT_DIR / "game_content" / "environment_config.yaml",
--
GitLab