Skip to content

Commit

Permalink
Added PyPI release workflow; (hopefully) fixed missing website template
Browse files Browse the repository at this point in the history
  • Loading branch information
njbirth committed Dec 16, 2023
1 parent b5baef3 commit d50d426
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 4 deletions.
47 changes: 47 additions & 0 deletions .github/workflows/pypi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# See https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/

name: PyPI Release
on:
workflow_dispatch:
release:
types: [published]

jobs:
build:
name: Build distribution
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.x"
- name: Install pypa/build
run: python3 -m pip install build --user
- name: Build a binary wheel and a source tarball
run: python3 -m build
- name: Store the distribution packages
uses: actions/upload-artifact@v3
with:
name: python-package-distributions
path: dist/

publish-to-pypi:
name: Publish to PyPI
needs:
- build
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/p/cocopye
permissions:
id-token: write # IMPORTANT: mandatory for trusted publishing
steps:
- name: Download all dists
uses: actions/download-artifact@v3
with:
name: python-package-distributions
path: dist/
- name: Publish distribution to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
recursive-include src/cocopye/ui/web/static *
recursive-include src/cocopye/ui/web/templates *
include src/cocopye/ui/config.toml
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ indices than existing tools.

## Getting started

CoCoPyE is available via pip ~~and conda (conda-forge channel).~~ Coming soon. See the [project wiki](https://github.com/gobics/cocopye/wiki)
CoCoPyE is available via pip and conda (conda-forge channel). See the [project wiki](https://github.com/gobics/cocopye/wiki)
for installation and usage instructions.

- [Quickstart](https://github.com/gobics/cocopye/wiki/Quickstart)
Expand All @@ -23,7 +23,7 @@ for installation and usage instructions.

### Online Demo

You can test CoCoPyE without installation on [our project homepage](https://cocopye.uni-goettingen.de). Please note that the online demo can process only
You can test CoCoPyE without installation on ~~[our project homepage](https://cocopye.uni-goettingen.de)~~ ***coming soon***. Please note that the online demo can process only
one query genome per request and is less performant than a local installation. Therefore it is highly recommended to use the online
version only for evaluation purposes and install CoCoPyE on your own machine for productive use.

Expand All @@ -36,7 +36,7 @@ or send an email to [[email protected]](mailto:[email protected]). ***(TODO: Rep

### API documentation

You can find the API documentation of the CoCoPyE package on [https://gobics.github.com/cocopye](https://gobics.github.com/cocopye).
You can find the API documentation of the CoCoPyE package on [https://gobics.github.io/cocopye](https://gobics.github.com/cocopye).

### License

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "cocopye"
version = "0.1.2"
version = "0.1.3"
authors = [
{ name = "Niklas Birth, Nicolina Leppich, Dr. Peter Meinicke" },
]
Expand Down

0 comments on commit d50d426

Please sign in to comment.