adding github actions workflow to upload to pypi upon release

Author: fsecada01

.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -7,3 +7,4 @@ labs
 .venv
 tests
 *.7z
+*.env

TextSpitter/core.py

@@ -1,5 +1,5 @@
 """
-Doc String
+Core application that contains the `FileExtractor` class object
 """
 
 import mimetypes
@@ -24,6 +24,9 @@ def __init__(
         The extractor wrapper will initialize by assigning the filename to the
         object's file property; if a file-like object is provided instead of a
         name, then a file_ext arg will be required.
+
+        `file_name` is depreciated.
+
         Args:
             file_obj: str | Path | None
             filename: : str | None
@@ -32,19 +35,24 @@ def __init__(
         if filename:
             self.file = FileIO(filename)
             self.file_ext = filename.split(".")[-1]
+        elif isinstance(file_obj, str):
+            file_obj = Path(file_obj)
+
         elif file_obj and any((isinstance(file_obj, x) for x in (Path, IO))):
-            if hasattr(file_obj, "name"):
-                self.file = file_obj
-                self.file_ext = file_obj.name.split(".")[-1]
-            else:
-                raise Exception(
-                    "Your file object does not contain a name attribute. Please"
-                    " add a name attribute with a file extension, and try "
-                    "again. Need the file ext. data for mime-typing."
-                )
+            pass
+
+        if hasattr(file_obj, "name"):
+            self.file = file_obj
+            self.file_ext = file_obj.name.split(".")[-1]
+        else:
+            raise Exception(
+                "Your file object does not contain a name attribute. Please"
+                " add a name attribute with a file extension, and try "
+                "again. Need the file ext. data for mime-typing."
+            )
 
     @staticmethod
-    def get_file_type(file):
+    def get_file_type(file: str | Path):
         """
         A static method that guesses the mime type for a given file object.
         The return value is taken from the sliced value from