Dev Commit (#10)

ericspod · web-flow · commit d370b9bb5cea · 2021-06-14T23:21:24.000+01:00
* Update randomdataset.rst * Update index.rst * Update conf.py and index.rst * Update .gitignore, conf.py, and 3 more files... * File updates and restructuring * Update generator.py * Updates and reorganization * Adding notebook for Exetera example * Update exeteraschema.json * Added Exetera example * CI/CD fix * Cleanup * Adding Codecov support * Update README.md * Tweak * Adding documentation * Adding Documentation * Adding commentary * Notebook update * Remove path line * Update * Added merge example * Adding examples * Fix * Added _version.py file for clean versioning in setup.py This avoids importing the package in the setup.py file, which would fail if dependencies are missing * Fix * Pypi release (#9) * ExeTera Example and Version Changes (#8) * Update randomdataset.rst * Update index.rst * Update conf.py and index.rst * Update .gitignore, conf.py, and 3 more files... * File updates and restructuring * Update generator.py * Updates and reorganization * Adding notebook for Exetera example * Update exeteraschema.json * Added Exetera example * CI/CD fix * Cleanup * Adding Codecov support * Update README.md * Tweak * Adding documentation * Adding Documentation * Adding commentary * Notebook update * Remove path line * Update * Added merge example * Adding examples * Fix * Added _version.py file for clean versioning in setup.py This avoids importing the package in the setup.py file, which would fail if dependencies are missing * Fix * Create python-publish.yml * Update README.md, _version.py, and setup.py
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -0,0 +1,36 @@
+# This workflow 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
+
+# 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@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/README.md b/README.md
@@ -74,13 +74,27 @@ A relatively simple set of features which link into the code are set up on this
 Both ReadTheDocs and Codecov are integrated with the repo as webhooks. These can be setup through their respective sites
 which require Github credentials to link with repos.
 
-This repo mostly follows [GitFlow](http://datasift.github.io/gitflow/IntroducingGitFlow.html) with a `master` branch which is always
-the current release of the code, and a `dev` branch that is the development version of the code. 
-Branch protection rules are in place for `master` which ensure that code can only be committed to the branch through reviewed PRs:
+This repo mostly follows [GitFlow](http://datasift.github.io/gitflow/IntroducingGitFlow.html) with a `master` branch 
+which is always the current release of the code, and a `dev` branch that is the development version of the code. 
+Branch protection rules are in place for `master` which ensure that code can only be committed to the branch through 
+reviewed PRs:
 
 * Require pull request reviews before merging
 * Require status checks to pass before merging ("build" action selected)
 * Require branches to be up to date before merging 
 * Require linear history 
 * Include administrators
 
+## PyPI Release
+
+Whenever a new release is made this is uploaded automatically to PyPI using the default Github workflow "Publish Python 
+Package". To upload to PyPI [these steps](https://packaging.python.org/tutorials/packaging-projects/) explain the 
+process. For this repo the basic steps are:
+
+1. Create account on pypi.org
+2. Create a wheel file with `python setup.py bdist_wheel`, this creates `dist/RandomDataset-0.1.0-py3-none-any.whl`
+3. Upload this package manually to PyPI with `python -m twine upload dist/*` (assuming you have twine already installed)
+4. Get the API token for the new package and set it to the secret `PYPI_API_TOKEN` in the repository's settings
+5. Add the workflow file `.github/workflows/python-publish.yml` from [here](https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml).
+6. Commit changes and create a release for the project, this should upload to PyPI automatically
+
diff --git a/randomdataset/_version.py b/randomdataset/_version.py
@@ -2,9 +2,15 @@
 # Copyright (c) 2021 Eric Kerfoot, KCL, see LICENSE file
 
 __appname__ = "RandomDataset"
-__version_info__ = (0, 1, 0)  # global application version, major/minor/patch
+__version_info__ = (0, 1, 2)  # global application version, major/minor/patch
 __version__ = "%i.%i.%i" % __version_info__
 __description__ = "Random dataset generation tool"
 __author__ = "Eric Kerfoot, KCL"
 __author_email__ = "eric.kerfoot@kcl.ac.uk"
 __copyright__ = "Copyright (c) 2021 Eric Kerfoot, King's College London, all rights reserved. Licensed under MIT License (see LICENSE.txt)."
+__url__ = "https://github.com/ericspod/RandomDataset"
+__license__ = "MIT"
+__long_description__ = """
+RandomDataset is a tool for generating randomized tabular data for testing databases, import routines, algorithms, etc.
+It's oriented towards creating CSV files primarily for importation into simple database structures or tables.
+""".strip()
diff --git a/setup.py b/setup.py
@@ -5,10 +5,13 @@
 from setuptools import setup, find_packages
 from pkg_resources import parse_requirements
 
+# It's important to note that this file doesn't import randomdataset to get the version information, but interprets
+# the _version.py file instead. This prevents the situation when installing using this file without all the depenencies
+# already present, this file won't be runnable in this case. 
 
 source_dir = os.path.abspath(os.path.dirname(__file__))
 
-# read the version and other strings from _version.py
+# read the version and other data from _version.py
 with open(os.path.join(source_dir, "randomdataset/_version.py")) as o:
     exec(o.read())
 
@@ -20,8 +23,11 @@
     name=__appname__,
     version=__version__,
     description=__description__,
+    long_description=__long_description__,
     author=__author__,
     author_email=__author_email__,
+    url=__url__,
+    license=__license__,
     packages=find_packages(),
     install_requires=requirements,
     entry_points={"console_scripts": ["generate_dataset = randomdataset:generate_dataset"]},
