ipyclip 0.0.1__tar.gz

ipyclip-0.0.1/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+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.

ipyclip-0.0.1/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: ipyclip
+Version: 0.0.1
+Summary: Clipboard utility for ipython
+Author-email: Boaz <boaz.iclip@gmail.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+## iClip
+A clipboard utility similar to windows' clip.exe for ipython.

ipyclip-0.0.1/README.md

@@ -0,0 +1,2 @@
+## iClip
+A clipboard utility similar to windows' clip.exe for ipython.

ipyclip-0.0.1/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["setuptools >= 82.0.1", "pyperclip >=1.11.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ipyclip"
+version = "0.0.1"
+authors = [
+  { name="Boaz", email="boaz.iclip@gmail.com" },
+]
+description = "Clipboard utility for ipython"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+#[project.urls]
+#Homepage = "https://github.com/pypa/sampleproject"
+#Issues = "https://github.com/pypa/sampleproject/issues"

ipyclip-0.0.1/setup.cfg

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

ipyclip-0.0.1/src/iclip/ClipboardManager.py

@@ -0,0 +1,112 @@
+"""
+Clipboard Manager Class.
+"""
+
+import sys
+from pyperclip import copy
+from functools import wraps
+from typing import *
+
+
+class ClipboardManager:
+    """
+    Clipboard Manager Class.
+    """
+
+    def __init__(self, stream_name: Literal["stdout", "stderr"]):
+        # get stream and preserve original write
+        self.stream = getattr(sys, stream_name)
+        self.original_write = self.stream.write
+
+        # clip management
+        self.copy_invoked = False
+        self.copy_buffer = ""
+        self.last_clip = ""
+        self.stream_buffer = ""
+        self.error = None
+
+    def _stream_write_wrapper(self, stream_write_function):
+        wraps(stream_write_function)
+
+        def wrapper(data, *args, **kwargs):
+            """
+            Saves anything written to the stream in the stream buffer.
+            :params: same as sys.stdout.write
+            :return: same as sys.stdout.write
+            """
+            # keep original return value
+            result = stream_write_function(data, *args, **kwargs)
+            self.stream_buffer += data
+            return result
+
+        return wrapper
+
+    def _handle_exception(self, e):
+        """
+        TODO: Retrofit with a more robust Exception object.
+        :param e: exception thrown in execution.
+        :return: None
+        """
+        self.original_write("An error occurred while copying")
+        self.error = e
+
+    def __lt__(self, other):
+        """
+        stage output for copying.
+        override current.
+        :param other:
+        :return: None
+        """
+        self.copy_invoked = True
+        self.copy_buffer = self.stream_buffer
+        return other
+
+    def __rrshift__(self, other):
+        """
+        stage the stdout for copying.
+        add to current.
+        :param other:
+        :return:
+        """
+        self.copy_invoked = True
+        self.copy_buffer += self.stream_buffer
+        return other
+
+    def __ror__(self, other):
+        """
+        Functions exactly the same as __lt__ but keeps the return value of the original statement.
+        :return: other
+        """
+        self.__lt__(other)
+        return other
+
+    def __call__(self, *args, **kwargs):
+        self.copy_invoked = True
+
+    def reset_buffer(self):
+        """
+        resets the clipboard buffer.
+        meant to be called by an event handler before execution.
+        :return:
+        """
+        self.copy_invoked = False
+        self.stream_buffer = ""
+        self.stream.write = self._stream_write_wrapper(self.stream.write)
+
+    def flush_to_clipboard(self):
+        """
+        Flush buffer to clipboard.
+        Used as a callback after every execution.
+        :return: None
+        """
+        if self.copy_invoked:
+            if self.copy_buffer and self.copy_buffer != self.last_clip:
+                try:
+                    copy(self.copy_buffer)
+                    self.last_clip = self.copy_buffer
+                except Exception as e:
+                    self._handle_exception(e)
+
+        # stage copy buffer for next-cell invocation
+        else:
+            self.copy_buffer = self.stream_buffer

ipyclip-0.0.1/src/iclip/ipyclip.py

@@ -0,0 +1,11 @@
+"""
+Ipython clipboard management extension
+"""
+
+def load_ipython_extension(ipython):
+    from ClipboardManager import ClipboardManager
+    print("IPython loaded")
+    clip = ClipboardManager(stream_name="stdout")
+    ipython.push("clip")
+    ipython.events.register("pre_execute", clip.reset_buffer)
+    ipython.events.register("post_execute", clip.flush_to_clipboard)

ipyclip-0.0.1/src/ipyclip.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: ipyclip
+Version: 0.0.1
+Summary: Clipboard utility for ipython
+Author-email: Boaz <boaz.iclip@gmail.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+## iClip
+A clipboard utility similar to windows' clip.exe for ipython.

ipyclip-0.0.1/src/ipyclip.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+src/iclip/ClipboardManager.py
+src/iclip/__init__.py
+src/iclip/ipyclip.py
+src/ipyclip.egg-info/PKG-INFO
+src/ipyclip.egg-info/SOURCES.txt
+src/ipyclip.egg-info/dependency_links.txt
+src/ipyclip.egg-info/top_level.txt

ipyclip-0.0.1/src/ipyclip.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ipyclip-0.0.1/src/ipyclip.egg-info/top_level.txt

@@ -0,0 +1 @@
+iclip