notionhelper 0.1.4__tar.gz → 0.1.6__tar.gz

{notionhelper-0.1.4 → notionhelper-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: notionhelper
-Version: 0.1.4
+Version: 0.1.6
 Summary: Add your description here
 Author-email: Jan du Plessis <drjanduplessis@icloud.com>
 Requires-Python: >=3.12
@@ -140,3 +140,48 @@ file_upload_id = upload_response["id"]
 page_id = "your_page_id"
 attach_response = helper.attach_file_to_page(page_id, file_upload_id)
 print(f"Successfully uploaded and attached file: {attach_response}")
+```
+
+### Simplified File Operations
+
+NotionHelper provides convenient one-step methods that combine file upload and attachment operations:
+
+#### one_step_image_embed()
+Uploads an image and embeds it in a Notion page in a single call, combining what would normally require:
+1. Uploading the file
+2. Embedding it in the page
+
+```python
+page_id = "your_page_id"
+image_path = "path/to/image.png"
+response = helper.one_step_image_embed(page_id, image_path)
+print(f"Successfully embedded image: {response}")
+```
+
+#### one_step_file_to_page()
+Uploads a file and attaches it to a Notion page in one step, combining:
+1. Uploading the file
+2. Attaching it to the page
+
+```python
+page_id = "your_page_id"
+file_path = "path/to/document.pdf"
+response = helper.one_step_file_to_page(page_id, file_path)
+print(f"Successfully attached file: {response}")
+```
+
+#### one_step_file_to_page_property()
+Uploads a file and attaches it to a specific Files & Media property on a page, combining:
+1. Uploading the file
+2. Attaching it to the page property
+
+```python
+page_id = "your_page_id"
+property_name = "Files"  # Name of your Files & Media property
+file_path = "path/to/document.pdf"
+file_name = "Custom Display Name.pdf"  # Optional display name
+response = helper.one_step_file_to_page_property(page_id, property_name, file_path, file_name)
+print(f"Successfully attached file to property: {response}")
+```
+
+These methods handle all the intermediate steps automatically, making file operations with Notion much simpler.

{notionhelper-0.1.4 → notionhelper-0.1.6}/README.md

@@ -128,3 +128,48 @@ file_upload_id = upload_response["id"]
 page_id = "your_page_id"
 attach_response = helper.attach_file_to_page(page_id, file_upload_id)
 print(f"Successfully uploaded and attached file: {attach_response}")
+```
+
+### Simplified File Operations
+
+NotionHelper provides convenient one-step methods that combine file upload and attachment operations:
+
+#### one_step_image_embed()
+Uploads an image and embeds it in a Notion page in a single call, combining what would normally require:
+1. Uploading the file
+2. Embedding it in the page
+
+```python
+page_id = "your_page_id"
+image_path = "path/to/image.png"
+response = helper.one_step_image_embed(page_id, image_path)
+print(f"Successfully embedded image: {response}")
+```
+
+#### one_step_file_to_page()
+Uploads a file and attaches it to a Notion page in one step, combining:
+1. Uploading the file
+2. Attaching it to the page
+
+```python
+page_id = "your_page_id"
+file_path = "path/to/document.pdf"
+response = helper.one_step_file_to_page(page_id, file_path)
+print(f"Successfully attached file: {response}")
+```
+
+#### one_step_file_to_page_property()
+Uploads a file and attaches it to a specific Files & Media property on a page, combining:
+1. Uploading the file
+2. Attaching it to the page property
+
+```python
+page_id = "your_page_id"
+property_name = "Files"  # Name of your Files & Media property
+file_path = "path/to/document.pdf"
+file_name = "Custom Display Name.pdf"  # Optional display name
+response = helper.one_step_file_to_page_property(page_id, property_name, file_path, file_name)
+print(f"Successfully attached file to property: {response}")
+```
+
+These methods handle all the intermediate steps automatically, making file operations with Notion much simpler.

{notionhelper-0.1.4 → notionhelper-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "notionhelper"
-version = "0.1.4"
+version = "0.1.6"
 description = "Add your description here"
 readme = "README.md"
 authors = [

{notionhelper-0.1.4 → notionhelper-0.1.6}/src/notionhelper/helper.py

@@ -475,3 +475,60 @@ class NotionHelper:
 
         # Attach the file to the page property
         return self.attach_file_to_page_property(page_id, property_name, file_upload_id, file_name)
+
+    def info(self):
+        """Displays comprehensive library information in a Jupyter notebook.
+
+        Shows:
+        - Library name and description
+        - Complete list of all available methods with descriptions
+        - Version information
+        - Optional logo display (if available)
+
+        Returns:
+            IPython.display.HTML: An HTML display object or None if IPython is not available.
+        """
+        try:
+            from IPython.display import HTML
+            import base64
+            import inspect
+
+            # Get logo image data
+            logo_path = os.path.join(os.path.dirname(__file__), '../images/helper_logo.png')
+            if os.path.exists(logo_path):
+                with open(logo_path, "rb") as image_file:
+                    encoded_logo = base64.b64encode(image_file.read()).decode('utf-8')
+            else:
+                encoded_logo = ""
+
+            # Get all methods and their docstrings
+            methods = []
+            for name, method in inspect.getmembers(self, predicate=inspect.ismethod):
+                if not name.startswith('_'):
+                    doc = inspect.getdoc(method) or "No description available"
+                    methods.append(f"<li><code>{name}()</code>: {doc.splitlines()[0]}</li>")
+
+            # Create HTML content
+            html_content = f"""
+            <div style="font-family: 'Inter', -apple-system, BlinkMacSystemFont, sans-serif; max-width: 800px; margin: 0 auto; color: #1e293b;">
+                <h1 style="color: #1e293b;">NotionHelper Library</h1>
+                {f'<img src="data:image/png;base64,{encoded_logo}" style="max-width: 200px; margin: 20px 0; display: block;">' if encoded_logo else ''}
+                <p style="font-size: 1.1rem;">A Python helper class for interacting with the Notion API.</p>
+                <h3 style="color: #1e293b;">All Available Methods:</h3>
+                <ul style="list-style-type: none; padding-left: 0;">
+                    {''.join(methods)}
+                </ul>
+                <h3 style="color: #1e293b;">Features:</h3>
+                <ul style="list-style-type: none; padding-left: 0;">
+                    <li style="margin-bottom: 8px;">Database querying and manipulation</li>
+                    <li style="margin-bottom: 8px;">Page creation and editing</li>
+                    <li style="margin-bottom: 8px;">File uploads and attachments</li>
+                    <li style="margin-bottom: 8px;">Data conversion to Pandas DataFrames</li>
+                </ul>
+                <p style="font-size: 0.9rem; color: #64748b;">Version: {getattr(self, '__version__', '1.0.0')}</p>
+            </div>
+            """
+            return HTML(html_content)
+        except ImportError:
+            print("IPython is required for this functionality. Please install it with: pip install ipython")
+            return None

{notionhelper-0.1.4 → notionhelper-0.1.6}/uv.lock

@@ -163,7 +163,7 @@ wheels = [
 
 [[package]]
 name = "notionhelper"
-version = "0.1.3"
+version = "0.1.6"
 source = { editable = "." }
 dependencies = [
     { name = "mimetype" },