Version 2.0 (#46)

rdbende · Sep 11, 2022 · de635b2 · de635b2
1 parent 3b80890
commit de635b2
Show file tree

Hide file tree

Showing 370 changed files with 8,687 additions and 1,190 deletions.
diff --git a/.github/workflows/generate_spritesheet.yml b/.github/workflows/generate_spritesheet.yml
@@ -0,0 +1,27 @@
+
+name: Generate sprite sheet
+
+on:
+  push:
+    paths:
+      - 'src/dark/**.png'
+      - 'src/light/**.png'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install packages
+      run: |
+        cd src
+        npm install
+    - name: Generate sprite sheet image and sprite map
+      run: |
+        cd src
+        node spritesheet_generator.js
+    - uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        commit_message: "Automation: Update sprite sheets"
+        file_pattern: theme/*.*
diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml
@@ -0,0 +1,32 @@
+name: Upload to Pypi
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.9"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Prepare package
+      run: |
+        mkdir sv_ttk
+        cp -r sv_ttk.py sv.tcl theme sv_ttk
+        mv sv_ttk/sv_ttk.py sv_ttk/__init__.py
+    - name: Build and publish to Pypi
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,15 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Dependency directories
+node_modules/
+
+# Build directories
+sv_ttk/
+build/
+dist/
+sdist/
+wheels/
+*.egg-info/
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/rdbende/Sun-Valley-ttk-theme/master/assets/dark.png">
-  <img alt="Cover image" src="https://raw.githubusercontent.com/rdbende/Sun-Valley-ttk-theme/master/assets/light.png">
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/rdbende/Sun-Valley-ttk-theme/master/assets/hero_dark.png">
+  <img alt="Cover image" src="https://raw.githubusercontent.com/rdbende/Sun-Valley-ttk-theme/master/assets/hero_light.png">
 </picture>
 
 ## Installation [![image](https://static.pepy.tech/badge/sv-ttk)](https://pypi.org/project/sv-ttk)
@@ -12,75 +12,28 @@ pip install sv-ttk
 
 
 ### Usage
+For detailed documentation, see the [wiki page](https://github.com/rdbende/Sun-Valley-ttk-theme/wiki/sv_ttk-docs)
 
 ```python
-import tkinter as tk
+import tkinter
+from tkinter import ttk
+
 import sv_ttk
 
 root = tk.Tk()
 
-sv_ttk.set_theme("light")  # Set light theme
-sv_ttk.set_theme("dark")  # Set dark theme
-
-sv_ttk.use_light_theme()  # Set light theme
-sv_ttk.use_dark_theme()  # Set dark theme
+button = ttk.Button(root, text="Click me!")
+button.pack()
 
-sv_ttk.toggle_theme()  # Toggle between dark and light theme
-
-print(sv_ttk.get_theme())  # Get what theme the app uses (either 'light' or 'dark')
+# This where the magic happens
+sv_ttk.set_theme("dark")
 
 root.mainloop()
 ```
 
-## Usage with Tcl/Tk
-To make setting the theme and the right colours as easy as possible, there is a separate script that handles all this.
-This way whether you want to use a dark or light theme, you need to import just a single file, and the colors will be
-configured even for non-ttk widgets for a consistent look.
-
-```tcl
-source sun-valley.tcl
-
-set_theme light  ;# Set light theme
-# or
-set_theme dark  ;# Set dark theme
-```
-
-### Switching themes
-Normally changing between themes isn't that easy, because then the colors doesn't get configured correctly. See this [SO question](https://stackoverflow.com/questions/66576662/how-to-switch-between-dark-and-light-ttk-theme).
-However, with my current solution, you can change theme at any time, without any color issues.
-
-```tcl
-package require Tk 8.6
-source "sun-valley.tcl"
-
-set_theme light
-
-# Pack a big frame so, it behaves like the window background
-ttk::frame .big_frame
-pack .big_frame -fill both -expand 1
-
-proc changeTheme {} {
-    # NOTE: The theme's real name is sun-valley-<mode>
-    if {[ttk::style theme use] == "sun-valley-dark"} {
-        # Set light theme
-        set_theme light
-    } else {
-        # Set dark theme
-        set_theme dark
-    }
-}
-
-ttk::button .big_frame.button -text "Change theme!" -command changeTheme
-pack .big_frame.button
-```
-
-## Bugs
-- Tk isn't really good at displaying `png` images, so if your program is laggy with the theme, please check out the [gif-based branch!](https://github.com/rdbende/Sun-Valley-ttk-theme/tree/gif-based/) (hasn't been updated for a while)
-- When you change the theme, and your app has a `treeview`, the window resizes. This is a quite strange bug that applies to other ttk themes too. 
 
-## Examples
-I made a separate repo for the examples: [Sun-Valley-ttk-examples](https://github.com/rdbende/Sun-Valley-ttk-examples). 
-Be sure to **star** and **watch** it because I might make some more examples, with awesome tips and tricks!
+## Known bugs and limitations
+- Tkinter (Tk) isn't really good at displaying `png` images, so the window can be quite laggy when resizing, especially on Windows.
 
 ## What's next?
 Check out my other ttk themes!

diff --git a/assets/cover_dark.png b/assets/cover_dark.png
diff --git a/assets/cover_light.png b/assets/cover_light.png
diff --git a/assets/dark.png b/assets/dark.png
diff --git a/assets/hero_dark.png b/assets/hero_dark.png
diff --git a/assets/hero_light.png b/assets/hero_light.png
diff --git a/assets/light.png b/assets/light.png
diff --git a/assets/social.png b/assets/social.png
diff --git a/setup.py b/setup.py
@@ -0,0 +1,53 @@
+from setuptools import setup
+
+with open("README.md", "r") as file:
+    long_description = file.read()
+
+
+setup(
+    name="sv_ttk",
+    version="2.0",
+    license="MIT",
+    author="rdbende",
+    author_email="[email protected]",
+    url="https://github.com/rdbende/Sun-Valley-ttk-theme",
+    project_urls={
+        "Source": "https://github.com/rdbende/Sun-Valley-ttk-theme",
+        "Tracker": "https://github.com/rdbende/Sun-Valley-ttk-theme/issues",
+    },
+    description="A gorgeous theme for Tkinter that looks like Windows 11",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    packages=["sv_ttk"],
+    package_data={"sv_ttk": ["sv.tcl", "theme/*"]},
+    python_requires=">=3.4",
+    classifiers=[
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: User Interfaces",
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Tcl",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    keywords=[
+        "dark-theme",
+        "sun-valley",
+        "tcl",
+        "tcl/tk",
+        "theme",
+        "theme",
+        "tile",
+        "tk",
+        "tkinter",
+        "ttk",
+        "windows-11",
+        "winui",
+    ],
+)
diff --git a/src/dark/README.md b/src/dark/README.md
@@ -0,0 +1,16 @@
+# Source images for Sun Valley dark theme
+
+This directory contains the source images of `spritesheet_dark.png` (which is generated by `spritesheet_generator.js`), and the SVG source file as well.
+
+## How to generate the png files?
+
+1. Open `dark.svg` with [Inkscape](https://inkscape.org/)
+2. Press Ctrl+Shift+E
+3. Select every element that _doesn't_ have transparency and click on the `Selection` tab in the export box
+4. Click `Batch export <blah> selected objects`
+5. Click on `Advanced`
+6. Set the bit depth to `RGB_8` and the antialiasing to `CAIRO_ANTIALIAS_GOOD (default)`
+7. Click `Export`
+8. Now select every item that _has_ transparency
+9. Set the bit depth to `RGBA_8` and the antialiasing to `CAIRO_ANTIALIAS_BEST`
+10. Click `Export`
diff --git a/src/dark/button-accent-dis.png b/src/dark/button-accent-dis.png
diff --git a/src/dark/button-accent-focus-hover.png b/src/dark/button-accent-focus-hover.png
diff --git a/src/dark/button-accent-focus.png b/src/dark/button-accent-focus.png
diff --git a/src/dark/button-accent-hover.png b/src/dark/button-accent-hover.png
diff --git a/src/dark/button-accent-pressed.png b/src/dark/button-accent-pressed.png
diff --git a/src/dark/button-accent-rest.png b/src/dark/button-accent-rest.png
diff --git a/src/dark/button-dis.png b/src/dark/button-dis.png
diff --git a/src/dark/button-focus-hover.png b/src/dark/button-focus-hover.png
diff --git a/src/dark/button-focus.png b/src/dark/button-focus.png
diff --git a/src/dark/button-hover.png b/src/dark/button-hover.png
diff --git a/src/dark/button-pressed.png b/src/dark/button-pressed.png
diff --git a/src/dark/button-rest.png b/src/dark/button-rest.png
diff --git a/src/dark/card.png b/src/dark/card.png
diff --git a/src/dark/check-dis.png b/src/dark/check-dis.png
diff --git a/src/dark/check-focus-hover.png b/src/dark/check-focus-hover.png
diff --git a/src/dark/check-focus.png b/src/dark/check-focus.png
diff --git a/src/dark/check-hover.png b/src/dark/check-hover.png
diff --git a/src/dark/check-pressed.png b/src/dark/check-pressed.png
diff --git a/src/dark/check-rest.png b/src/dark/check-rest.png
diff --git a/src/dark/check-tri-dis.png b/src/dark/check-tri-dis.png
diff --git a/src/dark/check-tri-focus-hover.png b/src/dark/check-tri-focus-hover.png
diff --git a/src/dark/check-tri-focus.png b/src/dark/check-tri-focus.png
diff --git a/src/dark/check-tri-hover.png b/src/dark/check-tri-hover.png
diff --git a/src/dark/check-tri-pressed.png b/src/dark/check-tri-pressed.png
diff --git a/src/dark/check-tri-rest.png b/src/dark/check-tri-rest.png
diff --git a/src/dark/check-unsel-dis.png b/src/dark/check-unsel-dis.png
diff --git a/src/dark/check-unsel-focus-hover.png b/src/dark/check-unsel-focus-hover.png
diff --git a/src/dark/check-unsel-focus.png b/src/dark/check-unsel-focus.png
diff --git a/src/dark/check-unsel-hover.png b/src/dark/check-unsel-hover.png
diff --git a/src/dark/check-unsel-pressed.png b/src/dark/check-unsel-pressed.png
diff --git a/src/dark/check-unsel-rest.png b/src/dark/check-unsel-rest.png