Merge pull request leixingyu#5 from hannesdelbeke/master

package this repo as a python module

Author: leixingyu

.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -25,29 +25,23 @@ Hence the creation of this tool!
 The tool needs the following library to be installed:
 
 - Qt for Python: [PySide2](https://pypi.org/project/PySide2/) or [PyQt5](https://pypi.org/project/PyQt5/)
-
 - Python shim for all Qt bindings: [Qt.py](https://pypi.org/project/Qt.py/)
 
 
 ### Add as Menu Button
 
 The tool is meant to be launched from a menu bar button like such:
 
-<div align="center">
 <img src="https://i.imgur.com/IcQGGu5.png" alt="menu">
-</div>
 
 You can set up this very easily by adding `startup.py` as a startup script,
 under _Project Settings - Plugins - Python_
 
-- download the project zip file where you can find the `startup.py`, add
-that location to the startup scripts: 
-e.g. _"C:\Downloads\unrealScriptEditor\startup.py"_
+- download & extract the project zip file
+- find the `startup.py` location, and add it to the startup scripts: e.g. `C:\Downloads\unrealScriptEditor\startup.py`
 
 
-<div align="center">
 <img src="https://i.imgur.com/wJrkp5b.png" alt="menu">
-</div>
 
 ### Simple Launch Script
 
@@ -63,6 +57,11 @@ global editor
 editor = main.show()
 ```
 
+### Install as module
+Install the module from the repo
+```bash
+python -m pip install git+https://github.com/hannesdelbeke/unreal-script-editor
+```
 
 ## Features
 

pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+#build-backend = "setuptools.build_meta"
+
+
+[tool.setuptools]
+packages = ["unreal-script-editor"]
+
+
+[project]
+name = "unreal-script-editor"
+authors = [
+    {name = "Lei Xingyu"},
+    {name = "Hannes Delbeke"},
+]
+description = "A Qt Python script editor, styled in Unreal stylesheet"
+readme = "README.md"
+requires-python = ">=3.4"
+keywords = ["unreal", "scripter"]
+license = { file = "LICENSE" }
+classifiers = [
+    "Programming Language :: Python :: 3.7",
+]
+#dynamic = ["dependencies"]
+dependencies = ['importlib-metadata; python_version<"3.7"', "Qt.py", "unreal-stylesheet"]
+#dynamic = ["version"]
+version = "0.0.1"
+
+#[project.optional-dependencies]
+#yaml = ["pyyaml"]
+
+#[project.scripts]
+#my-script = "my_package.module:function"
+
+[project.urls]
+Homepage = "https://github.com/leixingyu/unrealScriptEditor"
+Source = "https://github.com/leixingyu/unrealScriptEditor"