Skip to content

Commit

Permalink
Add infrastructure for publishing to PyPI (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshKarpel authored Apr 6, 2021
1 parent 6bd7c57 commit 2b442b7
Show file tree
Hide file tree
Showing 6 changed files with 67 additions and 14 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/publish-to-pypi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: publish-to-pypi

on:
release:
types: [published]

jobs:
build-and-publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.x
uses: actions/setup-python@v2
with:
python-version: "3.x"
- uses: snok/install-poetry@v1.1.2
with:
virtualenvs-create: true
- name: Build the package
run: poetry build -vvv
- name: Publish to PyPI
run: poetry publish --username __token__ --password ${{ secrets.pypi_token }}
working-directory: ${{ github.workspace }}
2 changes: 1 addition & 1 deletion .github/workflows/quality-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:
- name: Install package
run: poetry install --no-interaction
- name: Make sure we can build the package
run: poetry build
run: poetry build -vvv
- name: Run tests
run: poetry run pytest --cov --cov-report=xml
- name: Upload coverage
Expand Down
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# spiel
# Spiel

![PyPI](https://img.shields.io/pypi/v/spiel)
[![Documentation Status](https://readthedocs.org/projects/spiel/badge/?version=latest)](https://spiel.readthedocs.io/en/latest/?badge=latest)
![PyPI - License](https://img.shields.io/pypi/l/spiel)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/JoshKarpel/spiel/main.svg)](https://results.pre-commit.ci/latest/github/JoshKarpel/spiel/main)
[![codecov](https://codecov.io/gh/JoshKarpel/spiel/branch/main/graph/badge.svg?token=2sjP4V0AfY)](https://codecov.io/gh/JoshKarpel/spiel)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

![GitHub issues](https://img.shields.io/github/issues/JoshKarpel/spiel)
![GitHub pull requests](https://img.shields.io/github/issues-pr/JoshKarpel/spiel)

Spiel is a framework for building and presenting richly-styled presentations in your terminal using Python.

To see what Spiel can do, install it (`pip install spiel`), then run this command to view the demonstration deck:
```bash
$ spiel demo present
```
18 changes: 9 additions & 9 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 17 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,25 @@ line_length = 100

[tool.poetry]
name = "spiel"
version = "0.1.0"
description = "Present slides in your terminal."
version = "0.1.1"
description = "A framework for building and presenting richly-styled presentations in your terminal using Python."
readme="README.md"
homepage="https://github.com/JoshKarpel/spiel"
documentation="https://spiel.readthedocs.io/en/latest/"
classifiers = [
"Development Status :: 3 - Alpha",
"Environment :: Console",
"License :: OSI Approved :: MIT License",
"Operating System :: MacOS",
"Operating System :: Unix",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Topic :: Multimedia :: Graphics :: Presentation",
"Typing :: Typed",
]
authors = ["JoshKarpel <josh.karpel@gmail.com>"]
license = "MIT"
include = ["demo/*"]
include = ["py.typed", "demo/*"]

[tool.poetry.dependencies]
python = "^3.9"
Expand Down
Empty file added spiel/py.typed
Empty file.

0 comments on commit 2b442b7

Please sign in to comment.