peek-python 1.8.1__tar.gz → 1.8.3__tar.gz

{peek_python-1.8.1 → peek_python-1.8.3}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 1.8.1
+Version: 1.8.3
 Summary: peek - debugging and benchmarking made easy
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
-Project-URL: Homepage, https://github.com/salabim/ycecream
-Project-URL: Repository, https://github.com/salabim/ycecream
+Project-URL: Homepage, https://github.com/salabim/peek
+Project-URL: Repository, https://github.com/salabim/peek
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3 :: Only
@@ -1099,9 +1099,34 @@ Examples:
 This will print one line with`1` only.
 
 # Copying to the clipboard
-It is possible to copy a value to the clipbaord with the method `to_clipboard` which accepts a value to be copied to the clipboard.
-So,
+It is possible to copy a value to the clipboard. There are two ways:
 
+### With peek(*args, to_clipboard=True)
+
+With the optional keyword argument, *to_clipboard*:
+
+- If to_clipboard==False (the default), nothing is copied to the clipboard.
+- If to_clipboard==True, the *value* of the the *first* parameter will be copied to the clipboard. The output itself is as usual.
+
+Examples:
+
+```
+part1 = 200
+extra = "extra"
+peek(part1, extra, to_clipboard=True)
+    # will print part1=200, extra='extra' and copy 200 to the clipboard
+peek(200, to_clipboard=True)\
+    # will print 200 and copy 200 to the clipboard
+peek(to_clipboard=True)
+    # will print #5 (or similar) and empty the clipboard
+```
+
+Note that *to_clipboard* is not a peek attribute and can only be used when calling `peek`,
+If as_str==True, to_clipboard is ignored.
+
+### With peek.to_clipboard
+
+Just use peek.to_clipboard to copy any value to the clipboard. So,
 ```
 part1 = 1234
 peek.to_clipboard(part1)
@@ -1114,7 +1139,9 @@ If the confirmation message is not wanted, just add confirm=False, like
 peek.to_clipboard(part1, confirm=False)
 ```
 
-Implementation detail: this functionality uses pyperclip, apart from under Pythonista, whre the
+### General
+
+Implementation detail: the clipboard functionality uses pyperclip, apart from under Pythonista, where the
 builtin clipboard module is used.
 
 This functionality is particularly useful for entering an answer of an *Advent of Code* solution to the site.

{peek_python-1.8.1 → peek_python-1.8.3}/README.md

@@ -1079,9 +1079,34 @@ Examples:
 This will print one line with`1` only.
 
 # Copying to the clipboard
-It is possible to copy a value to the clipbaord with the method `to_clipboard` which accepts a value to be copied to the clipboard.
-So,
+It is possible to copy a value to the clipboard. There are two ways:
 
+### With peek(*args, to_clipboard=True)
+
+With the optional keyword argument, *to_clipboard*:
+
+- If to_clipboard==False (the default), nothing is copied to the clipboard.
+- If to_clipboard==True, the *value* of the the *first* parameter will be copied to the clipboard. The output itself is as usual.
+
+Examples:
+
+```
+part1 = 200
+extra = "extra"
+peek(part1, extra, to_clipboard=True)
+    # will print part1=200, extra='extra' and copy 200 to the clipboard
+peek(200, to_clipboard=True)\
+    # will print 200 and copy 200 to the clipboard
+peek(to_clipboard=True)
+    # will print #5 (or similar) and empty the clipboard
+```
+
+Note that *to_clipboard* is not a peek attribute and can only be used when calling `peek`,
+If as_str==True, to_clipboard is ignored.
+
+### With peek.to_clipboard
+
+Just use peek.to_clipboard to copy any value to the clipboard. So,
 ```
 part1 = 1234
 peek.to_clipboard(part1)
@@ -1094,7 +1119,9 @@ If the confirmation message is not wanted, just add confirm=False, like
 peek.to_clipboard(part1, confirm=False)
 ```
 
-Implementation detail: this functionality uses pyperclip, apart from under Pythonista, whre the
+### General
+
+Implementation detail: the clipboard functionality uses pyperclip, apart from under Pythonista, where the
 builtin clipboard module is used.
 
 This functionality is particularly useful for entering an answer of an *Advent of Code* solution to the site.

{peek_python-1.8.1 → peek_python-1.8.3}/peek/peek.py

@@ -4,7 +4,7 @@
 #  | .__/  \___| \___||_|\_\
 #  |_| like print, but easy.
 
-__version__ = "1.8.1"
+__version__ = "1.8.3"
 
 """
 See https://github.com/salabim/peek for details
@@ -520,6 +520,7 @@ class _Peek:
         level = kwargs.pop("level", nv)
         enforce_line_length = kwargs.pop("enforce_line_length", nv)
         delta = kwargs.pop("delta", nv)
+        to_clipboard=kwargs.pop("to_clipboard", nv)
         as_str = kwargs.pop("as_str", nv)
         provided = kwargs.pop("provided", nv)
         pr = kwargs.pop("pr", nv)
@@ -528,6 +529,7 @@ class _Peek:
             raise TypeError("can't use both pr and provided")
 
         as_str = False if as_str is nv else bool(as_str)
+        to_clipboard=False if to_clipboard is nv else bool(to_clipboard)
         provided = True if provided is nv else bool(provided)
 
         this = self.fork()
@@ -776,6 +778,7 @@ class _Peek:
                 return out + "\n"
             else:
                 return ""
+        peek.to_clipboard(pairs[0].right if "pairs" in locals() else '',confirm=False)
         this.do_output(out)
 
         return return_args(args, this.return_none)

{peek_python-1.8.1 → peek_python-1.8.3}/peek_python.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: peek-python
-Version: 1.8.1
+Version: 1.8.3
 Summary: peek - debugging and benchmarking made easy
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
-Project-URL: Homepage, https://github.com/salabim/ycecream
-Project-URL: Repository, https://github.com/salabim/ycecream
+Project-URL: Homepage, https://github.com/salabim/peek
+Project-URL: Repository, https://github.com/salabim/peek
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3 :: Only
@@ -1099,9 +1099,34 @@ Examples:
 This will print one line with`1` only.
 
 # Copying to the clipboard
-It is possible to copy a value to the clipbaord with the method `to_clipboard` which accepts a value to be copied to the clipboard.
-So,
+It is possible to copy a value to the clipboard. There are two ways:
 
+### With peek(*args, to_clipboard=True)
+
+With the optional keyword argument, *to_clipboard*:
+
+- If to_clipboard==False (the default), nothing is copied to the clipboard.
+- If to_clipboard==True, the *value* of the the *first* parameter will be copied to the clipboard. The output itself is as usual.
+
+Examples:
+
+```
+part1 = 200
+extra = "extra"
+peek(part1, extra, to_clipboard=True)
+    # will print part1=200, extra='extra' and copy 200 to the clipboard
+peek(200, to_clipboard=True)\
+    # will print 200 and copy 200 to the clipboard
+peek(to_clipboard=True)
+    # will print #5 (or similar) and empty the clipboard
+```
+
+Note that *to_clipboard* is not a peek attribute and can only be used when calling `peek`,
+If as_str==True, to_clipboard is ignored.
+
+### With peek.to_clipboard
+
+Just use peek.to_clipboard to copy any value to the clipboard. So,
 ```
 part1 = 1234
 peek.to_clipboard(part1)
@@ -1114,7 +1139,9 @@ If the confirmation message is not wanted, just add confirm=False, like
 peek.to_clipboard(part1, confirm=False)
 ```
 
-Implementation detail: this functionality uses pyperclip, apart from under Pythonista, whre the
+### General
+
+Implementation detail: the clipboard functionality uses pyperclip, apart from under Pythonista, where the
 builtin clipboard module is used.
 
 This functionality is particularly useful for entering an answer of an *Advent of Code* solution to the site.

{peek_python-1.8.1 → peek_python-1.8.3}/pyproject.toml

@@ -8,7 +8,7 @@ authors = [
     {name = "Ruud van der Ham", email = "rt.van.der.ham@gmail.com"}
 ]
 description = "peek - debugging and benchmarking made easy"
-version = "1.8.1"
+version = "1.8.3"
 readme = "README.md"
 requires-python = ">=3.6"
 dependencies = ["colorama","six","executing","asttokens","tomli","pyperclip"]
@@ -19,9 +19,8 @@ classifiers = [
   "Programming Language :: Python :: 3 :: Only"
 ]
 [project.urls]
-Homepage = "https://github.com/salabim/ycecream"
-Repository = "https://github.com/salabim/ycecream"
-
+Homepage = "https://github.com/salabim/peek"
+Repository = "https://github.com/salabim/peek"
 
 [tool.setuptools]
 packages = ["peek"]