Merge pull request #4 from TheEric960/package-setup

Package Setup

Author: WolfpackWilson

.github/workflows/python-publish-test.yml

@@ -0,0 +1,31 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  pull_request:
+    types: [assigned, opened, reopened]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.TESTPYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.TESTPYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload --repository testpypi dist/*

.github/workflows/python-publish.yml

@@ -0,0 +1,31 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published, edited]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

README.md

@@ -1,2 +1,33 @@
 # pyvba
-A tool to browse and interact with win32com vba-based applications
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyvba)
+![PyPI](https://img.shields.io/pypi/v/pyvba)
+![GitHub](https://img.shields.io/github/license/TheEric960/pyvba)
+
+
+The pyvba package was designed to gather data from VBA-based applications (e.g. Microsoft Excel, CATIA, etc.). It
+may also be used to assist programming VBA macro scripts in a more sensical language. 
+
+## Getting Started
+Install the Python Package:
+```cmd
+pip install pyvba
+```
+
+To export data from a VBA program:
+```python
+import pyvba
+
+catia = pyvba.Browser("CATIA.Application")
+active_document = catia.ActiveDocument
+
+exporter = pyvba.XMLExport(active_document)
+exporter.save("output", r"C:\Documents")
+```
+
+The current supported output types are XML and JSON formats.
+
+## Developer Notes
+This package is still in alpha. Hence, there are still some problematic bugs and issues that cause errors in certain
+applications. Contributors are welcome! The project is [hosted on GitHub](https://github.com/TheEric960/pyvba). Report 
+any issues at [the issue tracker](https://github.com/TheEric960/pyvba/issues), but please check to see if the issue 
+already exists!

setup.py

@@ -0,0 +1,24 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="pyvba",
+    version="0.5.0",
+    author="TheEric960",
+    description="Data mine and write scrips for VBA applications on Windows.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/TheEric960/pyvba",
+    packages=setuptools.find_packages(),
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Environment :: Win32 (MS Windows)",
+        "License :: OSI Approved :: MIT License",
+        "Natural Language :: English",
+        "Operating System :: Microsoft :: Windows",
+        "Programming Language :: Python :: 3",
+    ],
+    python_requires='>=3',
+)