Skip to content

Commit

Permalink
Release prep 1.0 (#47)
Browse files Browse the repository at this point in the history
* Create python-publish.yml (#46)

* Create MANIFEST.in

* Update README.md

* Update setup.py
  • Loading branch information
mbmilligan authored Apr 13, 2021
1 parent 89324d4 commit 7b58a49
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 8 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
@@ -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/*
4 changes: 4 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
include *.md
include LICENSE
include version.py
include requirements.txt
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "[email protected], [email protected]",
author = "Michael Milligan",
author_email = "[email protected]",
url = "http://jupyter.org",
license = "BSD",
platforms = "Linux, Mac OS X",
Expand Down

0 comments on commit 7b58a49

Please sign in to comment.