Merge pull request #3 from davidhozic/develop

Develop

Author: davidhozic

.github/pull_request_template.md

@@ -0,0 +1,16 @@
+Pull request type:
+- [ ] Feature
+- [ ] Bug fix
+- [ ] Documentation
+- [ ] Breaking change 
+
+I have:
+- [ ] Tested the code
+- [ ] Wrote unit tests for the code
+- [ ] Documented changes:
+  - [ ] Guide(s)
+  - [ ] API reference
+  - [ ] Changelog
+
+Changes:
+- 

.github/workflows/create_release.yml

@@ -0,0 +1,41 @@
+on:
+  workflow_dispatch:
+    inputs:
+      version-major:
+        type: string
+        description: Major version (eg. x.0.0)
+      version-minor:
+        type: string
+        description: Minor version (eg. 0.x.0)
+
+      version-bugfix:
+        type: string
+        description: Bug fix version (eg. 0.0.x)
+        default: "0"
+
+name: Create Release
+
+jobs:
+  build:
+    name: Create Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@master
+      - name: Create tag
+        id: tag_version
+        uses: mathieudutour/[email protected]
+        with:
+          github_token: ${{ secrets.TOKEN_GH }}
+          custom_tag : ${{github.event.inputs.version-major}}.${{github.event.inputs.version-minor}}.${{github.event.inputs.version-bugfix}}
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.TOKEN_GH }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{ steps.tag_version.outputs.new_tag }}
+          release_name: ${{ steps.tag_version.outputs.new_tag }}
+          body: "Changelog: /en/v${{github.event.inputs.version-major}}.${{github.event.inputs.version-minor}}.x/changelog.html"
+          draft: false
+          prerelease: false

.github/workflows/python-publish.yml

@@ -0,0 +1,36 @@
+name: Publish to PyPi
+
+on:
+  release:
+    types: [published]
+
+  workflow_dispatch:
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.x"
+        cache: 'pip'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install build
+
+    - name: Build
+      run: |
+        python -m build
+
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@b7f401de30cb6434a1e19f805ff006643653240e
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -70,6 +70,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/source/reference/
 
 # PyBuilder
 .pybuilder/
@@ -158,3 +159,7 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+
+
+**test.py**

MANIFEST.in

@@ -0,0 +1 @@
+graft tkclasswiz

README.rst

@@ -0,0 +1,78 @@
+=========================================================
+TkClassWizard
+=========================================================
+TkClassWizard - define objects graphically based on class annotations.
+The library allows users to create abstract "ObjectInfo" objects based on the class's parameters, which
+can later be converted to real Python objects and vice versa.
+
+---------------------
+Links
+---------------------
+- `Releases <https://github.com/davidhozic/TkClassWizard/releases>`_
+- Need help? Contact me in my `Discord server <https://discord.gg/DEnvahb2Sw>`_.
+
+----------------------
+Installation
+----------------------
+DAF can be installed though command prompt/terminal using the bottom commands.
+        
+Pre-requirement: `Python (minimum v3.8) <https://www.python.org/downloads/>`_
+
+
+.. code-block:: bash
+
+    pip install tkclasswiz
+
+----------------------
+Example
+----------------------
+
+.. image:: docs/source/guide/images/new_define_frame_struct_new_str.png
+    :width: 15cm
+
+.. code-block:: python
+
+    import tkinter as tk
+    import tkinter.ttk as ttk
+    import tkclasswiz as wiz
+
+
+    # Normal Python classes with annotations (type hints)
+    class Wheel:
+        def __init__(self, diameter: float):
+            self.diameter = diameter
+
+    class Car:
+        def __init__(self, name: str, speed: float, wheels: list[Wheel]):
+            self.name = name
+            self.speed = speed
+            self.wheels = wheels
+
+    # Tkinter main window
+    root = tk.Tk("Test")
+
+    # Modified tkinter Combobox that will store actual objects instead of strings
+    combo = wiz.ComboBoxObjects(root)
+    combo.pack(fill=tk.X, padx=5)
+
+    def make_car(old = None):
+        """
+        Function for opening a window either in new definition mode (old = None) or
+        edit mode (old != None)
+        """
+        assert old is None or isinstance(old, wiz.ObjectInfo)
+
+        window = wiz.ObjectEditWindow()  # The object definition window / wizard
+        window.open_object_edit_frame(Car, combo, old_data=old)  # Open the actual frame
+
+    def print_defined():
+        data = combo.get()
+        data = wiz.convert_to_objects(data)  # Convert any abstract ObjectInfo objects into actual Python objects
+        print(f"Object: {data}; Type: {type(data)}",)  # Print the object and it's datatype
+
+
+    # Main GUI structure
+    ttk.Button(text="Define Car", command=make_car).pack()
+    ttk.Button(text="Edit Car", command=lambda: make_car(combo.get())).pack()
+    ttk.Button(text="Print defined", command=print_defined).pack()
+    root.mainloop()

docs/Makefile

@@ -0,0 +1,47 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     ?= source
+BUILDDIR      ?= build
+USE_LANGUAGE  ?= sl
+
+export LANGUAGE=$(USE_LANGUAGE)
+
+_BUILD_DIR = $(BUILDDIR)/$(SOURCEDIR)
+
+# OS specific commands
+ifeq ($(OS), Windows_NT)
+LATEX_CMD := \
+	cp $(CURDIR)/build-latex-win.sh $(CURDIR)/$(_BUILD_DIR)/latex/ &&\
+	wsl --cd $(CURDIR)/$(_BUILD_DIR)/latex sh build-latex-win.sh
+
+else
+LATEX_CMD := cd $(CURDIR)/$(_BUILD_DIR)/latex && make all-pdf
+endif
+
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+
+clean:
+	python3 ./setup.py --clean --start-dir $(SOURCEDIR)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(_BUILD_DIR)" $(SPHINXOPTS) $(O)
+
+pdf: latex
+	mkdir -p $(CURDIR)/$(_BUILD_DIR)/pdf/
+	$(LATEX_CMD)
+	cp $(CURDIR)/$(_BUILD_DIR)/latex/*.pdf $(CURDIR)/$(_BUILD_DIR)/pdf/
+
+%: Makefile
+	python3 ./setup.py --start-dir $(SOURCEDIR)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(_BUILD_DIR)" $(SPHINXOPTS) $(O)

docs/build-latex-win.sh

@@ -0,0 +1,21 @@
+# Script is created to speed up the latex compilation on the windows system though wsl.
+# It copis all latex files to a wsl directory, runs the latex compiler and then copies them back
+# to the orignal path.
+
+ORIGIN_DIR=$(pwd)
+LATEX_BUILD_PATH=~/latex-build/
+
+# Copy the current folder (latex build folder) contents to our home folder
+echo Creating dir $LATEX_BUILD_PATH
+mkdir -p $LATEX_BUILD_PATH
+
+echo Copying files to $LATEX_BUILD_PATH
+cp -r $ORIGIN_DIR/** $LATEX_BUILD_PATH
+
+echo Building latex
+cd $LATEX_BUILD_PATH
+make all-pdf
+cp -r $LATEX_BUILD_PATH/** $ORIGIN_DIR
+
+echo Cleaning up $LATEX_BUILD_PATH
+rm -rf $LATEX_BUILD_PATH

docs/dep_local.json

@@ -0,0 +1,4 @@
+{
+    "copy": [],
+    "scripts": []
+}

docs/setup.py

@@ -0,0 +1,72 @@
+"""
+Script that setups the environment before build.
+"""
+
+from pathlib import Path
+from argparse import ArgumentParser
+
+import runpy
+import re
+import os
+import glob
+import shutil
+import json
+
+
+parse = ArgumentParser()
+parse.add_argument("--clean", action="store_true", default=False, help="If given, it will only clean instead of copy and run")
+parse.add_argument("--start-dir", default="./", dest="start_dir", help="Where to start looking for dep_local.json")
+args = parse.parse_args()
+
+
+CLEAN_ARG: bool = args.clean
+START_DIR_ARG: str = args.start_dir
+
+# Work relatively to the setup script location
+os.chdir(os.path.dirname(__file__))
+
+for path, dirs, files in os.walk(START_DIR_ARG):
+    for file in files:
+        if file == "dep_local.json":
+            file = os.path.join(path, file)
+            # Copy files
+            setup_file_data: dict = None
+            with open(file, 'r', encoding="utf-8") as setup_file:
+                setup_file_data = json.load(setup_file)
+
+            # While copying change to dep-files cwd
+            cwd = os.getcwd()
+            os.chdir(os.path.abspath(os.path.dirname(file)))
+            # [(from, to), (from, to)]
+            destinations = setup_file_data["copy"]
+            for dest in destinations:
+                cp_from = dest["from"]
+                cp_to = dest["to"]
+                if re.search(r"\.[A-z]+$", cp_to) is None:  # The path does not have extension -> assume a dir
+                    _src = [x for x in glob.glob(cp_from, recursive=True) if os.path.isfile(x)]
+                    _dest = [os.path.join(cp_to, os.path.basename(m)) for m in _src]
+                else:
+                    _src = [cp_from]
+                    _dest = [cp_to]
+
+                srcdest = zip(_src, _dest)
+                for fromf, tof in srcdest:
+                    if CLEAN_ARG:
+                        if os.path.exists(tof):
+                            os.remove(tof)
+                    else:
+                        tof_dir = Path(os.path.dirname(tof))
+                        tof_dir.mkdir(parents=True, exist_ok=True)
+                        shutil.copy2(fromf, tof)
+
+            # Run scripts
+            if CLEAN_ARG:
+                os.chdir(cwd)
+                continue
+
+            scripts = setup_file_data["scripts"]
+            for script in scripts:
+                runpy.run_path(script)
+
+            # Change cwd back to original
+            os.chdir(cwd)