Skip to content

Commit 7b58a49

Browse files
authored
Release prep 1.0 (#47)
* Create python-publish.yml (#46) * Create MANIFEST.in * Update README.md * Update setup.py
1 parent 89324d4 commit 7b58a49

File tree

4 files changed

+42
-8
lines changed

4 files changed

+42
-8
lines changed

.github/workflows/python-publish.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# This workflow will upload a Python Package using Twine when a release is created
2+
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
3+
4+
name: Upload Python Package
5+
6+
on:
7+
release:
8+
types: [released]
9+
10+
jobs:
11+
deploy:
12+
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Set up Python
18+
uses: actions/setup-python@v2
19+
with:
20+
python-version: '3.x'
21+
- name: Install dependencies
22+
run: |
23+
python -m pip install --upgrade pip
24+
pip install build twine
25+
- name: Build and publish
26+
env:
27+
TWINE_USERNAME: '__token__'
28+
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
29+
run: |
30+
python -m build
31+
python -m twine upload dist/*

MANIFEST.in

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
include *.md
2+
include LICENSE
3+
include version.py
4+
include requirements.txt

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
# wrapspawner for Jupyterhub
22

3-
[![Build Status](https://travis-ci.org/jupyterhub/wrapspawner.svg?branch=master)](https://travis-ci.org/jupyterhub/wrapspawner)
4-
53
This package includes **WrapSpawner** and **ProfilesSpawner**, which provide mechanisms for runtime configuration of spawners.
64
The inspiration for their development was to allow users to select from a range of pre-defined batch job profiles, but
75
their operation is completely generic.
86

97
## Installation
108

11-
1. From root directory of this repo (where setup.py is), run `pip install -e .`
9+
1. Most users can install via pip:
1210

13-
If you don't actually need an editable version, you can simply run:
14-
15-
`pip install git+https://github.com/jupyterhub/wrapspawner`
11+
`pip install wrapspawner`
12+
13+
To install an editable copy for development, from root directory of this repo (where setup.py is), run `pip install -e .`
14+
See also [pip VCS support](https://pip.pypa.io/en/stable/reference/pip_install/#vcs-support) if you need a specific revision.
1615

1716
2. Add lines in `jupyterhub_config.py` for the spawner you intend to use, e.g.
1817

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
version = version_ns['__version__'],
3030
description = """Wrapspawner: A spawner for Jupyterhub to wrap other spawners and allow the user to choose among them.""",
3131
long_description = "",
32-
author = "Michael Milligan, Andrea Zonca",
33-
32+
author = "Michael Milligan",
33+
author_email = "[email protected]",
3434
url = "http://jupyter.org",
3535
license = "BSD",
3636
platforms = "Linux, Mac OS X",

0 commit comments

Comments
 (0)