fshstorage 1.0.0__tar.gz

fshstorage-1.0.0/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 maxeepy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

fshstorage-1.0.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: fshstorage
+Version: 1.0.0
+Summary: FshStorage API Wrapper written in Python
+Author: maxie
+License-Expression: MIT
+Project-URL: Homepage, https://codeberg.org/maxeepy/fshstorage-wrapper
+Project-URL: Issues, https://codeberg.org/maxeepy/fshstorage-wrapper/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.30
+Requires-Dist: fshlink
+Dynamic: license-file
+
+# fshstorage
+
+## Examples
+
+### Logging in and getting a list of files
+
+```py
+from fshstorage import FshStorageWrapper
+
+fsh = FshStorageWrapper("token")
+print(fsh.list_files()) # Returns a dictionary of file_name: FshStoragePartailFile's
+
+```
+
+### Downloading a file
+
+```py
+file1 = api.download_file("name.png")
+print(file1) # Returns a FshStorageFile
+
+# ------
+
+list_of_files = api.files()
+
+file2 = list_of_files["name.png"]
+print(list_of_files["name.png"]) # Returns a FshStoragePartialFile
+
+file2 = file2.download()
+print(file2) # Returns a FshFile
+```
+
+### Sharing a file
+
+```py
+file1.share() # Returns a https://link.fsh.plus/... (FshShortenedLink object)
+api.share_file("name.png") # Returns a https://link.fsh.plus/... (FshShortenedLink object)
+```
+
+### Saving a file
+
+```py
+file1.save() # Defaults to the name attribute in file1 (will download to your current working directory)
+file2.save("name.png") # Saves the file to the specified path/name 
+```
+
+### Deleting a file
+
+```py
+api.delete_file("name.png")
+```
+
+### Renaming a file
+
+```py
+api.rename_file("name.png", "waaaaaa.png")
+```

fshstorage-1.0.0/README.md

@@ -0,0 +1,56 @@
+# fshstorage
+
+## Examples
+
+### Logging in and getting a list of files
+
+```py
+from fshstorage import FshStorageWrapper
+
+fsh = FshStorageWrapper("token")
+print(fsh.list_files()) # Returns a dictionary of file_name: FshStoragePartailFile's
+
+```
+
+### Downloading a file
+
+```py
+file1 = api.download_file("name.png")
+print(file1) # Returns a FshStorageFile
+
+# ------
+
+list_of_files = api.files()
+
+file2 = list_of_files["name.png"]
+print(list_of_files["name.png"]) # Returns a FshStoragePartialFile
+
+file2 = file2.download()
+print(file2) # Returns a FshFile
+```
+
+### Sharing a file
+
+```py
+file1.share() # Returns a https://link.fsh.plus/... (FshShortenedLink object)
+api.share_file("name.png") # Returns a https://link.fsh.plus/... (FshShortenedLink object)
+```
+
+### Saving a file
+
+```py
+file1.save() # Defaults to the name attribute in file1 (will download to your current working directory)
+file2.save("name.png") # Saves the file to the specified path/name 
+```
+
+### Deleting a file
+
+```py
+api.delete_file("name.png")
+```
+
+### Renaming a file
+
+```py
+api.rename_file("name.png", "waaaaaa.png")
+```

fshstorage-1.0.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools >= 77.0.3", "requests >= 2.30", "fshlink"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fshstorage"
+authors = [
+  { name = "maxie" }
+]
+description = "FshStorage API Wrapper written in Python"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+	"requests >= 2.30",
+	"fshlink"
+]
+classifiers = [
+	"Programming Language :: Python :: 3",
+	"Programming Language :: Python :: 3.10",
+	"Programming Language :: Python :: 3.11",
+	"Programming Language :: Python :: 3.12",
+	"Programming Language :: Python :: 3.13",
+	"Programming Language :: Python :: 3.14",
+	"Operating System :: OS Independent"
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://codeberg.org/maxeepy/fshstorage-wrapper"
+Issues = "https://codeberg.org/maxeepy/fshstorage-wrapper/issues"
+
+[tool.setuptools.dynamic]
+version = { attr = "fshstorage.__version__" }

fshstorage-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fshstorage-1.0.0/src/fshstorage/__init__.py

@@ -0,0 +1,3 @@
+from .fshstorage import *
+
+__version__ = "1.0.0"

fshstorage-1.0.0/src/fshstorage/constants.py

@@ -0,0 +1,3 @@
+KB = 1024 * 1024
+MB = 1024 * KB
+CHUNK_SIZE = 2 * MB

fshstorage-1.0.0/src/fshstorage/fshstorage.py

@@ -0,0 +1,148 @@
+import requests
+from fshlink import FshShortenedLink
+from .constants import CHUNK_SIZE, MB, KB
+from contextlib import ExitStack
+from mimetypes import guess_type
+from pathlib import Path
+from io import IOBase, BytesIO
+from typing import Union
+
+class FileSize:
+	def __init__(self, size: int):
+		self.raw = size
+		self.human = self.raw / KB
+		self.limit = 10 * MB
+		self.human_limit = 10
+	
+	def __str__(self):
+		return f"{round(self.human, 2)}MB/{self.human_limit}MB"
+
+	def __repr__(self):
+		raw = self.raw
+		human = self.human
+		limit = self.limit
+		return f"FileSize({raw=}, {human=}, {limit=})"
+
+class FshStoragePartialFile:
+	def __init__(self, name: str, type: str, size: int, message: str, chunkSize: int, _base_url: str, _session: requests.Session):
+		self.name = name
+		self.mimetype = type
+		self.size = FileSize(size)
+		self.message_id = message
+		self._chunk_size = chunkSize
+		self._base_url = _base_url
+		self._session = _session
+	
+	def download(self) -> "FshStorageFile":
+		url = f"{self._base_url}/download"
+		response = self._session.get(url, params = {"m": self.message_id})
+		if not response.ok:
+			raise Exception(response.status_code)
+		chunks = []
+		for chunk in response.iter_content(CHUNK_SIZE):
+			chunks.append(chunk)
+		return FshStorageFile(b"".join(chunks), self.name, self.mimetype, self.size)
+
+	def share(self) -> FshShortenedLink:
+		url = f"{self._base_url}/share"
+		response = self._session.post(url, params = {"m": self.message_id})
+		return FshShortenedLink(response.json()["link"])
+
+	def __str__(self):
+		return f"{self._base_url}/download?m={self.message_id}"
+
+	def __repr__(self):
+		name = self.name
+		mimetype = self.mimetype
+		size = self.size
+		message = self.message_id
+		return f"FshStoragePartialFile({name=}, {mimetype=}, {size=}, {message=})"
+
+class FshStorageFile(BytesIO):
+	def __init__(self, file: Union[IOBase, str, bytes], name: str, type: str = None, size: Union[int, FileSize] = None):
+		super().__init__(file)
+		self.name = name
+		self.mimetype = type
+		if type is None:
+			self.mimetype = guess_type(self.name)[0] or "application/octet-stream"
+
+		self.size = size if isinstance(size, FileSize) else FileSize(size) 
+			
+	def save(self, path: Union[str, Path]) -> None:
+		with open(path, "wb") as f:
+			f.write(self.read())
+	
+	def __str__(self):
+		return self.name
+
+	def __repr__(self):
+		name = self.name
+		mimetype = self.mimetype
+		size = self.size
+		return f"FshStorageFile({name=}, {mimetype=}, {size=})"
+
+	def __del__(self):
+		self.close()
+
+class FshStorageDictionary(dict):
+	def __init__(self, data, _session: requests.Session, _base_url: str = "https://storage.fsh.plus"):
+		super().__init__({item["name"]: FshStoragePartialFile(**item, _base_url=_base_url, _session=_session) for item in data})
+
+class FshStorageWrapper:
+	def __init__(self, fsh_storage_token: str, *, base_url: str = "https://storage.fsh.plus"):
+		self.token = fsh_storage_token
+		self._session = requests.Session()
+		self._session.headers = {"Cookie": f"FshAccountToken={self.token}"}
+		self.base_url = base_url
+		self._base_url = base_url + "/api"
+		self.file_list = self.list_files()
+	
+	def list_files(self) -> FshStorageDictionary:
+		url = f"{self._base_url}/files"
+		response = self._session.get(url)
+		return FshStorageDictionary(response.json(), _session = self._session, _base_url = self._base_url)
+
+	def upload_file(self, name: str, file: Union[str, FshStorageFile]) -> requests.Response:
+		stack = ExitStack()
+		file_mime = None
+		if isinstance(file, str):
+			file = Path(file)
+			file_mime = guess_type(file.name)[0]
+		elif isinstance(file, FshStorageFile):
+			file_mime = file.mimetype
+		else:
+			raise ValueError("file is not str or FshStorageFile")
+		
+		url = f"{self._base_url}/upload"
+		response = self._session.post(url, params = {"name": name if name not in self.file_list else f"New {name}", "type": file_mime}, data = file if not isinstance(file, Path) else stack.enter_context(file.open("rb")), headers = {"Content-Type": "application/octet-stream"})
+		self.file_list = self.list_files()
+		return response
+
+	def overwrite_file(self, name: str, file: IOBase) -> requests.Response:
+		self.delete_file(name)
+		return self.upload_file(name, file)
+
+	def rename_file(self, name: str, new_name: str) -> requests.Response:
+		url = f"{self._base_url}/rename"
+		response = self._session.post(url, params = {"m": self.file_list[name].message_id, "name": new_name})
+		self.file_list = self.list_files()
+		return response
+
+	def share_file(self, name: str) -> FshShortenedLink:
+		return self.file_list[name].share()
+
+	def download_file(self, name: str) -> FshStorageFile:
+		return self.file_list[name].download()
+
+	def delete_file(self, name: str):
+		url = f"{self._base_url}/delete"
+		response = self._session.post(url, params = {"m": self.file_list[name].message_id})
+		self.file_list = self.list_files()
+		return response
+
+	def __str__(self):
+		base_url = self.base_url
+		return f"FshStorageWrapper(token=..., {base_url=})"
+
+	def __repr__(self):
+		return self.__str__()

fshstorage-1.0.0/src/fshstorage.egg-info/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: fshstorage
+Version: 1.0.0
+Summary: FshStorage API Wrapper written in Python
+Author: maxie
+License-Expression: MIT
+Project-URL: Homepage, https://codeberg.org/maxeepy/fshstorage-wrapper
+Project-URL: Issues, https://codeberg.org/maxeepy/fshstorage-wrapper/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.30
+Requires-Dist: fshlink
+Dynamic: license-file
+
+# fshstorage
+
+## Examples
+
+### Logging in and getting a list of files
+
+```py
+from fshstorage import FshStorageWrapper
+
+fsh = FshStorageWrapper("token")
+print(fsh.list_files()) # Returns a dictionary of file_name: FshStoragePartailFile's
+
+```
+
+### Downloading a file
+
+```py
+file1 = api.download_file("name.png")
+print(file1) # Returns a FshStorageFile
+
+# ------
+
+list_of_files = api.files()
+
+file2 = list_of_files["name.png"]
+print(list_of_files["name.png"]) # Returns a FshStoragePartialFile
+
+file2 = file2.download()
+print(file2) # Returns a FshFile
+```
+
+### Sharing a file
+
+```py
+file1.share() # Returns a https://link.fsh.plus/... (FshShortenedLink object)
+api.share_file("name.png") # Returns a https://link.fsh.plus/... (FshShortenedLink object)
+```
+
+### Saving a file
+
+```py
+file1.save() # Defaults to the name attribute in file1 (will download to your current working directory)
+file2.save("name.png") # Saves the file to the specified path/name 
+```
+
+### Deleting a file
+
+```py
+api.delete_file("name.png")
+```
+
+### Renaming a file
+
+```py
+api.rename_file("name.png", "waaaaaa.png")
+```

fshstorage-1.0.0/src/fshstorage.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+src/fshstorage/__init__.py
+src/fshstorage/constants.py
+src/fshstorage/fshstorage.py
+src/fshstorage.egg-info/PKG-INFO
+src/fshstorage.egg-info/SOURCES.txt
+src/fshstorage.egg-info/dependency_links.txt
+src/fshstorage.egg-info/requires.txt
+src/fshstorage.egg-info/top_level.txt

fshstorage-1.0.0/src/fshstorage.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fshstorage-1.0.0/src/fshstorage.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests>=2.30
+fshlink

fshstorage-1.0.0/src/fshstorage.egg-info/top_level.txt

@@ -0,0 +1 @@
+fshstorage