libjam 0.0.18__tar.gz → 0.0.19__tar.gz

{libjam-0.0.18 → libjam-0.0.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: libjam
-Version: 0.0.18
+Version: 0.0.19
 Summary: A library jam for Python.
 Project-URL: Homepage, https://github.com/philippkosarev/libjam
 Project-URL: Issues, https://github.com/philippkosarev/libjam/issues
@@ -25,22 +25,22 @@ pip install libjam
 libjam consists of of 6 modules:
 
 ### Captain
-responsible for handling command-line arguments
+Responsible for handling command-line arguments.
 
 ### Drawer
-responsible for file operations
+Responsible for file operations.
 
 ### Typewriter
-responsible for transforming and printing text
+Responsible for transforming and printing text.
 
 ### Clipboard
-responsible for working with lists
+Responsible for working with lists.
 
 ### Notebook
-responsible for configuration
+Responsible for configuration.
 
 ### Flashcard
-responsible for getting user input from the command line
+Responsible for getting user input from the command line.
 
 ## Example project
 ```python

{libjam-0.0.18 → libjam-0.0.19}/README.md

@@ -11,22 +11,22 @@ pip install libjam
 libjam consists of of 6 modules:
 
 ### Captain
-responsible for handling command-line arguments
+Responsible for handling command-line arguments.
 
 ### Drawer
-responsible for file operations
+Responsible for file operations.
 
 ### Typewriter
-responsible for transforming and printing text
+Responsible for transforming and printing text.
 
 ### Clipboard
-responsible for working with lists
+Responsible for working with lists.
 
 ### Notebook
-responsible for configuration
+Responsible for configuration.
 
 ### Flashcard
-responsible for getting user input from the command line
+Responsible for getting user input from the command line.
 
 ## Example project
 ```python

{libjam-0.0.18 → libjam-0.0.19}/libjam/drawer.py

@@ -45,19 +45,19 @@ class Drawer:
     path = realpath(path)
     return outpath(path)
 
-  # Returns True if give a path to folder
+  # Returns True if given a path to a folder.
   def is_folder(self, path: str):
     if path == '':
       return False
     path = realpath(path)
     return os.path.isdir(path)
 
-  # Returns True if give a path to file.
+  # Returns True if given a path to a file.
   def is_file(self, path: str):
     path = realpath(path)
     return os.path.isfile(path)
 
-  # Returns true if path exists.
+  # Returns True if path exists.
   def exists(self, path: str):
     path = realpath(path)
     is_file = self.is_folder(path)
@@ -369,8 +369,8 @@ class Drawer:
     temp = str(tempfile.gettempdir())
     return outpath(temp)
 
-  # Returns the size of given file/folder, in bytes.
-  def get_file_size(self, path: str):
+  # Returns the weight of given file/folder, in bytes.
+  def get_filesize(self, path: str):
     path = realpath(path)
     try:
       if self.is_file(path):
@@ -385,6 +385,34 @@ class Drawer:
       typewriter.print('Program aborted while gathering size of files.')
       sys.exit(1)
 
+  # Given a number of bytes, returns a human readable filesize as a tuple.
+  # Tuple format: (value: int, short_unit_name: str, long_unit_name: str)
+  # Example tuple: (6.986356, 'mb', 'megabytes')
+  def get_readable_filesize(self, filesize: int):
+    if filesize > 1000 ** 7:
+      value = filesize / 1000 ** 7
+      return (value, 'zb', 'zettabytes')
+    elif filesize > 1000 ** 6:
+      value = filesize / 1000 ** 6
+      return (value, 'eb', 'exabytes')
+    elif filesize > 1000 ** 5:
+      value = filesize / 1000 ** 5
+      return (value, 'pb', 'petabytes')
+    elif filesize > 1000 ** 4:
+      value = filesize / 1000 ** 4
+      return (value, 'tb', 'terabytes')
+    elif filesize > 1000 ** 3:
+      value = filesize / 1000 ** 3
+      return (value, 'gb', 'gigabytes')
+    elif filesize > 1000 ** 2:
+      value = filesize / 1000 ** 2
+      return (value, 'mb', 'megabytes')
+    elif filesize > 1000:
+      value = filesize / 1000 ** 1
+      return (value, 'kb', 'kilobytes')
+    else:
+      return (filesize, 'b', 'bytes')
+
   def open(self, path: str):
     path = realpath(path)
     if PLATFORM == 'Linux':

{libjam-0.0.18 → libjam-0.0.19}/pyproject.toml

@@ -14,7 +14,7 @@ include = [
 
 [project]
 name = "libjam"
-version = "0.0.18"
+version = "0.0.19"
 authors = [
   { name="Philipp Kosarev", email="philipp.kosarev@gmail.com" },
 ]