Merge pull request #36 from caktus/updated-pypi-setup-w-auto-publish

Updated pypi setup w auto publish

.github/workflows/release.yml

@@ -0,0 +1,31 @@
+# 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]
+
+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 build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

MANIFEST.in

@@ -1,5 +1,6 @@
 include LICENSE
 include README.rst
+include RELEASES.rst
 recursive-exclude tests *
 recursive-exclude * *.pyc *.pyo
 recursive-exclude **/__pycache__ *

README.rst

@@ -35,7 +35,7 @@ Installation
 
 pip install into your virtualenv::
 
-    $ pip install git+https://github.com/caktus/invoke-kubesae@X.Y.Z#egg=invoke-kubesae
+    $ pip install invoke-kubesae
 
 Usage
 -----
@@ -297,7 +297,7 @@ Info
 ----
 
 print-ansible-vars
-~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~
 
     A command to inspect any ansible variable by environment. If no variable is specified then it will
     print out the current k8s environment variables.
@@ -378,8 +378,7 @@ get_db_dump
 
         db_var (str): The variable name that the database connection is stored in.
 
-        filename (string, optional): A filename to store the dump. If None, will default
-	to {namespace}_database.dump.
+        filename (string, optional): A filename to store the dump. If None, will default to {namespace}_database.dump.
 
 restore_db_from_dump
 ~~~~~~~~~~~~~~~~~~~~
@@ -426,9 +425,4 @@ get_backup_from_hosting
     The use of this task requires the addition of `hosting_services_backup_folder` to your `tasks.py`
     configuration:
 
-        ns.configure(
-        {
-            ...
-            "hosting_services_backup_folder": "<PROJECT_FOLDER>",
-            ...
-        }
+        ns.configure({"hosting_services_backup_folder": "<PROJECT_FOLDER>",})

RELEASES.rst

@@ -1,6 +1,10 @@
 Releases
 ========
 
+v0.0.16, 2021-08-05
+~~~~~~~~~~~~~~~~~~~~
+
+* Kubesae is now a PyPI package
 
 v0.0.15, 2021-03-24
 ~~~~~~~~~~~~~~~~~~~~

setup.py

@@ -4,12 +4,15 @@
 
 setup(
     name="invoke-kubesae",
-    version="0.0.15",
+    version="0.0.16",
     packages=find_packages(exclude=["tests"]),
     url="https://github.com/caktus/invoke-kubesae",
     author="Caktus Group",
-    author_email="",
-    description="",
+    author_email="solutions@caktusgroup.com",
+    description="An invoke tasks library to manage a kubernetes project.",
+    long_description=open("README.rst").read(),
+    license="BSD",
+    include_package_data=True,
     install_requires=[
         "boto3>=1.16",
         "invoke>=1.4",
@@ -18,9 +21,11 @@
     ],
     python_requires=">=3.5",
     classifiers=[
+        "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",
-        "Topic :: Software Development :: Build Tools",
         "License :: OSI Approved :: BSD License",
+        "Operating System :: OS Independent",
         "Programming Language :: Python :: 3",
+        "Topic :: Software Development :: Build Tools",
     ],
 )