Update storage directory path in documentation from tmp/storage to ./upload_dir` (#73)

jowilf · web-flow · commit f1d480f3081d · 2023-06-07T22:11:17.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,4 @@ site
 .cache
 __pycache__/
 .pytest_cache/
+upload_dir/
diff --git a/README.md b/README.md
@@ -101,8 +101,8 @@ class Attachment(Base):
 
 
 # Configure Storage
-os.makedirs("/tmp/storage/attachment", 0o777, exist_ok=True)
-container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+os.makedirs("./upload_dir/attachment", 0o777, exist_ok=True)
+container = LocalStorageDriver("./upload_dir").get_container("attachment")
 StorageManager.add_storage("default", container)
 
 # Save your model
diff --git a/docs/index.md b/docs/index.md
@@ -100,8 +100,8 @@ class Attachment(Base):
 
 
 # Configure Storage
-os.makedirs("/tmp/storage/attachment", 0o777, exist_ok=True)
-container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+os.makedirs("./upload_dir/attachment", 0o777, exist_ok=True)
+container = LocalStorageDriver("./upload_dir").get_container("attachment")
 StorageManager.add_storage("default", container)
 
 # Save your model
diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md
@@ -86,8 +86,8 @@ class Attachment(Base):
 
 
 # Configure Storage
-os.makedirs("/tmp/storage/attachment", 0o777, exist_ok=True)
-container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+os.makedirs("./upload_dir/attachment", 0o777, exist_ok=True)
+container = LocalStorageDriver("./upload_dir").get_container("attachment")
 StorageManager.add_storage("default", container)
 
 
@@ -124,8 +124,8 @@ class Attachment(Base):
 
 
 # Configure Storage
-os.makedirs("/tmp/storage/attachment", 0o777, exist_ok=True)
-container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+os.makedirs("./upload_dir/attachment", 0o777, exist_ok=True)
+container = LocalStorageDriver("./upload_dir").get_container("attachment")
 StorageManager.add_storage("default", container)
 
 
diff --git a/docs/tutorial/setup-your-storage.md b/docs/tutorial/setup-your-storage.md
@@ -24,8 +24,8 @@ Before adding a storage, the first thing you need is to setup an apache libcloud
     from libcloud.storage.drivers.local import LocalStorageDriver
     from sqlalchemy_file.storage import StorageManager
 
-    os.makedirs("/tmp/storage/attachment", 0o777, exist_ok=True) # Make sure the directory exist
-    my_container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+    os.makedirs("./upload_dir/attachment", 0o777, exist_ok=True) # Make sure the directory exist
+    my_container = LocalStorageDriver("./upload_dir").get_container("attachment")
     StorageManager.add_storage("default", container)
 
     ```
diff --git a/docs/tutorial/using-files-in-models.md b/docs/tutorial/using-files-in-models.md
@@ -65,7 +65,7 @@ class Attachment(Base):
 ```
 and configure your storage like this
 ```python
-container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+container = LocalStorageDriver("./upload_dir").get_container("attachment")
 StorageManager.add_storage("default", container)
 ```
 
@@ -384,8 +384,8 @@ class Attachment(Base):
 
 
 # Configure Storage
-os.makedirs("/tmp/storage/attachment", 0o777, exist_ok=True)
-container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+os.makedirs("./upload_dir/attachment", 0o777, exist_ok=True)
+container = LocalStorageDriver("./upload_dir").get_container("attachment")
 StorageManager.add_storage("default", container)
 
 # Save your model
diff --git a/docs_src/example.py b/docs_src/example.py
@@ -20,8 +20,8 @@ class Attachment(Base):
 
 
 # Configure Storage
-os.makedirs("/tmp/storage/attachment", 0o777, exist_ok=True)
-container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+os.makedirs("./upload_dir/attachment", 0o777, exist_ok=True)
+container = LocalStorageDriver("./upload_dir").get_container("attachment")
 StorageManager.add_storage("default", container)
 
 # Save your model
diff --git a/docs_src/tutorial/quick-start/configure_storage.py b/docs_src/tutorial/quick-start/configure_storage.py
@@ -4,6 +4,6 @@
 from sqlalchemy_file.storage import StorageManager
 
 # Configure Storage
-os.makedirs("/tmp/storage/attachment", 0o777, exist_ok=True)
-container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+os.makedirs("./upload_dir/attachment", 0o777, exist_ok=True)
+container = LocalStorageDriver("./upload_dir").get_container("attachment")
 StorageManager.add_storage("default", container)
diff --git a/docs_src/tutorial/quick-start/save_your_model.py b/docs_src/tutorial/quick-start/save_your_model.py
@@ -20,8 +20,8 @@ class Attachment(Base):
 
 
 # Configure Storage
-os.makedirs("/tmp/storage/attachment", 0o777, exist_ok=True)
-container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+os.makedirs("./upload_dir/attachment", 0o777, exist_ok=True)
+container = LocalStorageDriver("./upload_dir").get_container("attachment")
 StorageManager.add_storage("default", container)
 
 # Save your model
diff --git a/docs_src/tutorial/using-files-in-models/007_multiple_file.py b/docs_src/tutorial/using-files-in-models/007_multiple_file.py
@@ -19,8 +19,8 @@ class Attachment(Base):
 
 
 # Configure Storage
-os.makedirs("/tmp/storage/attachment", 0o777, exist_ok=True)
-container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+os.makedirs("./upload_dir/attachment", 0o777, exist_ok=True)
+container = LocalStorageDriver("./upload_dir").get_container("attachment")
 StorageManager.add_storage("default", container)
 
 # Save your model
diff --git a/docs_src/tutorial/using-files-in-models/008_file_information.py b/docs_src/tutorial/using-files-in-models/008_file_information.py
@@ -20,8 +20,8 @@ class Attachment(Base):
 
 
 # Configure Storage
-os.makedirs("/tmp/storage/attachment", 0o777, exist_ok=True)
-container = LocalStorageDriver("/tmp/storage").get_container("attachment")
+os.makedirs("./upload_dir/attachment", 0o777, exist_ok=True)
+container = LocalStorageDriver("./upload_dir").get_container("attachment")
 StorageManager.add_storage("default", container)
 
 # Save your model
diff --git a/examples/fastapi/app.py b/examples/fastapi/app.py
@@ -28,8 +28,8 @@
 
 engine = create_engine("sqlite:///example.db?check_same_thread=False", echo=True)
 
-os.makedirs("/tmp/storage", 0o777, exist_ok=True)
-driver = get_driver(Provider.LOCAL)("/tmp/storage")
+os.makedirs("./upload_dir", 0o777, exist_ok=True)
+driver = get_driver(Provider.LOCAL)("./upload_dir")
 
 # cls = get_driver(Provider.MINIO)
 # driver = cls("minioadmin", "minioadmin", secure=False, host="127.0.0.1", port=9000)
diff --git a/examples/flask/app.py b/examples/flask/app.py
@@ -102,8 +102,8 @@ def serve_files(storage, file_id):
 
 
 if __name__ == "__main__":
-    os.makedirs("/tmp/storage", 0o777, exist_ok=True)
-    driver = get_driver(Provider.LOCAL)("/tmp/storage")
+    os.makedirs("./upload_dir", 0o777, exist_ok=True)
+    driver = get_driver(Provider.LOCAL)("./upload_dir")
 
     # cls = get_driver(Provider.MINIO)
     # driver = cls("minioadmin", "minioadmin", secure=False, host="127.0.0.1", port=9000)
