PyPi scafolding

preperations for future release

Author: bobreijnders-topicus

DISTRIBUTION.md

@@ -0,0 +1,36 @@
+# Distribution cheat sheet
+
+## Check if the package is installable
+```console
+pip install .[dev]
+```
+add `[dev]` to install the  `extras_require` packages, required to build a release, if you have defined them in your setup.py. Example:
+```python
+extras_require={"dev": ["twine>=4.0.2", "build>=1.0.3"]},
+```
+
+## Old way (binairy and wheel)
+Create binairies
+```console
+python setup.py bdist
+```
+Create whl
+```console
+python setup.py bdist_wheel
+```
+
+## New way (binairy and wheel)
+```console
+python -m build
+```
+
+## Uploading
+Using twine, check if everything is ok
+```console
+twine check dist/*
+```
+Then upload to PyPi test or production
+```console
+twine upload -r testpypi dist/*
+twine upload dist/*
+```

README.md

@@ -0,0 +1,3 @@
+# This is a placeholder for a future WebGUI package
+
+Please contact the maintainer for more information

setup.py

@@ -0,0 +1,25 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r") as f:
+    long_description = f.read()
+
+setup(
+    name="desktopwebgui",
+    version="0.0.2",
+    description="Create appealing desktop applications using HTML with Flask/Django/FastAPI",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/gitcodebob/DesktopWebGUI",
+    author="Bob Reijnders",
+    author_email="info@bobreijnders.nl",
+    license="MIT",
+    packages=find_packages(),
+    # zip_safe=False,
+    python_requires=">=3.10",
+    extras_require={"dev": ["twine>=4.0.2", "build>=1.0.3"]},
+    classifiers=[
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent",
+    ],
+)

src/desktopwebgui/__init__.py

@@ -0,0 +1,5 @@
+""" This is a placeholder. Future package code will be placed here"""
+
+
+def add_one(number: int) -> int:
+    return number + 1

src/desktopwebgui/example.py

@@ -0,0 +1,9 @@
+import unittest
+from ..src.example_package_bobrey.example import add_one
+
+
+class AdditionTest(unittest.TestCase):
+    def test_add_one(self) -> None:
+        self.assertEqual(add_one(0), 1)
+        self.assertEqual(add_one(-1), 0)
+        self.assertEqual(add_one(99), 100)