general: Add example script.

1 files changed, 22 insertions, 0 deletions

diff --git a/examples/example.py b/examples/example.py
new file mode 100644
index 0000000..9f7bf57
--- /dev/null
+++ b/examples/example.py
@@ -0,0 +1,22 @@
+"""pywal api example."""
+import pywal
+
+
+def main():
+    """Main function."""
+    image = "/home/dylan/Pictures/Wallpapers/anVmEaA.jpg"
+
+    # Return a dict with the palette.
+    colors = pywal.create_palette(image)
+
+    # Apply the palette to all open terminals.
+    # Second argument is a boolean for VTE terminals.
+    # Set it to true if the terminal you're using is
+    # VTE based. (xfce4-terminal, termite, gnome-terminal.)
+    pywal.send_sequences(colors, False)
+
+    # Reload xrdb, i3 and polybar.
+    pywal.reload_env()
+
+    # Set the wallpaper.
+    pywal.set_wallpaper(image)