From 7b58a499b528b5a95c5f8d9372fbedb7c352ed5f Mon Sep 17 00:00:00 2001 From: Michael Milligan Date: Tue, 13 Apr 2021 15:43:44 -0500 Subject: [PATCH] Release prep 1.0 (#47) * Create python-publish.yml (#46) * Create MANIFEST.in * Update README.md * Update setup.py --- .github/workflows/python-publish.yml | 31 ++++++++++++++++++++++++++++ MANIFEST.in | 4 ++++ README.md | 11 +++++----- setup.py | 4 ++-- 4 files changed, 42 insertions(+), 8 deletions(-) create mode 100644 .github/workflows/python-publish.yml create mode 100644 MANIFEST.in diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml new file mode 100644 index 0000000..3730402 --- /dev/null +++ b/.github/workflows/python-publish.yml @@ -0,0 +1,31 @@ +# 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 + +name: Upload Python Package + +on: + release: + types: [released] + +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 twine + - name: Build and publish + env: + TWINE_USERNAME: '__token__' + TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }} + run: | + python -m build + python -m twine upload dist/* diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..293d946 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,4 @@ +include *.md +include LICENSE +include version.py +include requirements.txt diff --git a/README.md b/README.md index 97c7b52..9eb375c 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,17 @@ # wrapspawner for Jupyterhub -[![Build Status](https://travis-ci.org/jupyterhub/wrapspawner.svg?branch=master)](https://travis-ci.org/jupyterhub/wrapspawner) - This package includes **WrapSpawner** and **ProfilesSpawner**, which provide mechanisms for runtime configuration of spawners. The inspiration for their development was to allow users to select from a range of pre-defined batch job profiles, but their operation is completely generic. ## Installation -1. From root directory of this repo (where setup.py is), run `pip install -e .` +1. Most users can install via pip: - If you don't actually need an editable version, you can simply run: - - `pip install git+https://github.com/jupyterhub/wrapspawner` + `pip install wrapspawner` + + To install an editable copy for development, from root directory of this repo (where setup.py is), run `pip install -e .` + See also [pip VCS support](https://pip.pypa.io/en/stable/reference/pip_install/#vcs-support) if you need a specific revision. 2. Add lines in `jupyterhub_config.py` for the spawner you intend to use, e.g. diff --git a/setup.py b/setup.py index 188992a..66f8eda 100755 --- a/setup.py +++ b/setup.py @@ -29,8 +29,8 @@ version = version_ns['__version__'], description = """Wrapspawner: A spawner for Jupyterhub to wrap other spawners and allow the user to choose among them.""", long_description = "", - author = "Michael Milligan, Andrea Zonca", - author_email = "milligan@umn.edu, code@andreazonca.com", + author = "Michael Milligan", + author_email = "milligan@umn.edu", url = "http://jupyter.org", license = "BSD", platforms = "Linux, Mac OS X",