Skip to content

Commit 310f240

Browse files
ZeitsperreZeitsperre
authored
Merge pull request #226 from bird-house/prepare_v083
Prepare v0.8.3
2 parents 2dda60e + b3bb472 commit 310f240

File tree

9 files changed

+147
-52
lines changed

9 files changed

+147
-52
lines changed

‎.github/workflows/main.yml

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
name: build ⚙️
22

3-
on: [ push, pull_request ]
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
48

59
jobs:
610
build:
711

812
runs-on: ubuntu-latest
913
strategy:
1014
matrix:
11-
python-version: [3.7, 3.8, 3.9, '3.10']
15+
python-version: ["3.7", "3.8", "3.9", "3.10"]
1216
steps:
1317
- uses: actions/checkout@v2
1418
- name: Install packages

‎.github/workflows/publish-pypi.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Publish Python 🐍 distributions 📦 to PyPI
2+
3+
on:
4+
release:
5+
types:
6+
- published
7+
8+
jobs:
9+
build-n-publish-pypi:
10+
name: Build and publish Python 🐍 distributions 📦 to PyPI
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- name: Set up Python3
15+
uses: actions/setup-python@v4
16+
with:
17+
python-version: "3.x"
18+
- name: Build a binary wheel and a source tarball
19+
run: python setup.py sdist bdist_wheel
20+
- name: Publish distribution 📦 to PyPI
21+
uses: pypa/gh-action-pypi-publish@release/v1
22+
with:
23+
user: __token__
24+
password: ${{ secrets.PYPI_API_TOKEN }}

‎.github/workflows/tag-testpypi.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Publish Python 🐍 distributions 📦 to TestPyPI
2+
3+
on:
4+
push:
5+
tags:
6+
- '*'
7+
8+
jobs:
9+
build-n-publish-testpypi:
10+
name: Build and publish Python 🐍 distributions 📦 to TestPyPI
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- name: Set up Python3
15+
uses: actions/setup-python@v4
16+
with:
17+
python-version: "3.x"
18+
- name: Build a binary wheel and a source tarball
19+
run: python setup.py sdist bdist_wheel
20+
- name: Publish distribution 📦 to Test PyPI
21+
uses: pypa/gh-action-pypi-publish@release/v1
22+
with:
23+
user: __token__
24+
password: ${{ secrets.TEST_PYPI_API_TOKEN }}
25+
repository_url: https://test.pypi.org/legacy/
26+
skip_existing: true

‎README.rst

+36-27
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,7 @@
22
Birdy
33
=====
44

5-
.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
6-
:target: http://birdy.readthedocs.io/en/latest/?badge=latest
7-
:alt: Documentation Status
8-
9-
.. image:: https://github.com/bird-house/birdy/workflows/build/badge.svg
10-
:target: https://github.com/bird-house/birdy/actions
11-
:alt: Build Status
12-
13-
.. image:: https://api.codacy.com/project/badge/Grade/da14405a9a6d4c2e9c405d9c0c8babe7
14-
:target: https://www.codacy.com/app/cehbrecht/birdy?utm_source=github.com&utm_medium=referral&utm_content=bird-house/birdy&utm_campaign=Badge_Grade
15-
:alt: Codacy Code Checks
16-
17-
.. image:: https://img.shields.io/github/license/bird-house/birdy.svg
18-
:target: https://github.com/bird-house/birdy/blob/master/LICENSE.txt
19-
:alt: GitHub license
20-
21-
.. image:: https://badges.gitter.im/bird-house/birdhouse.svg
22-
:target: https://gitter.im/bird-house/birdhouse?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
23-
:alt: Join the chat at https://gitter.im/bird-house/birdhouse
24-
5+
|PyPI| |Docs| |Build| |Codacy| |License| |Gitter|
256

267
Birdy (the bird)
278
*Birdy is not a bird but likes to play with them.*
@@ -32,17 +13,45 @@ It is using `OWSLib` from the `GeoPython` project.
3213
You can try Birdy online using Binder (just click on the binder link below),
3314
or view the notebooks on NBViewer.
3415

35-
.. image:: https://mybinder.org/badge_logo.svg
36-
:target: https://mybinder.org/v2/gh/bird-house/birdy.git/v0.8.2?filepath=notebooks
37-
:alt: Binder Launcher
16+
|Binder|
3817

39-
.. image:: https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg
40-
:target: https://nbviewer.jupyter.org/github/bird-house/birdy/tree/v0.8.2/notebooks/
41-
:alt: NBViewer
42-
:height: 20
18+
|NBViewer|
4319

4420
Birdy is part of the `Birdhouse`_ project.
4521

4622
Full `documentation <http://birdy.readthedocs.org/en/latest/>`_ is on ReadTheDocs.
4723

4824
.. _Birdhouse: http://bird-house.github.io/en/latest/
25+
26+
.. |PyPI| image:: https://img.shields.io/pypi/v/birdhouse-birdy.svg
27+
:target: https://pypi.python.org/pypi/birdhouse-birdy
28+
:alt: Python Package Index Build
29+
30+
.. |Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
31+
:target: http://birdy.readthedocs.io/en/latest/?badge=latest
32+
:alt: Documentation Status
33+
34+
.. |Build| image:: https://github.com/bird-house/birdy/workflows/build/badge.svg
35+
:target: https://github.com/bird-house/birdy/actions
36+
:alt: Build Status
37+
38+
.. |Codacy| image:: https://api.codacy.com/project/badge/Grade/da14405a9a6d4c2e9c405d9c0c8babe7
39+
:target: https://www.codacy.com/app/cehbrecht/birdy?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=bird-house/birdy&amp;utm_campaign=Badge_Grade
40+
:alt: Codacy Code Checks
41+
42+
.. |License| image:: https://img.shields.io/github/license/bird-house/birdy.svg
43+
:target: https://github.com/bird-house/birdy/blob/master/LICENSE.txt
44+
:alt: GitHub license
45+
46+
.. |Gitter| image:: https://badges.gitter.im/bird-house/birdhouse.svg
47+
:target: https://gitter.im/bird-house/birdhouse?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
48+
:alt: Join the chat at https://gitter.im/bird-house/birdhouse
49+
50+
.. |Binder| image:: https://mybinder.org/badge_logo.svg
51+
:target: https://mybinder.org/v2/gh/bird-house/birdy.git/v0.8.3?filepath=notebooks
52+
:alt: Binder Launcher
53+
54+
.. |NBViewer| image:: https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg
55+
:target: https://nbviewer.jupyter.org/github/bird-house/birdy/tree/v0.8.3/notebooks/
56+
:alt: NBViewer
57+
:height: 20

‎birdy/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# noqa: D100, D104
22

3-
__version__ = "0.8.2"
3+
__version__ = "0.8.3"
44

55
from .client import WPSClient
66
from .ipyleafletwfs import IpyleafletWFS # noqa: F401

‎docs/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
# The short X.Y version.
8080
version = ""
8181
# The full version, including alpha/beta/rc tags.
82-
release = "0.8.2"
82+
release = "0.8.3"
8383

8484
# The language for content autogenerated by Sphinx. Refer to documentation
8585
# for a list of supported languages.

‎docs/source/development.rst

+15-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Check out code from the birdy GitHub repo and start the installation::
1212
$ git clone https://github.com/bird-house/birdy.git
1313
$ cd birdy
1414
$ conda env create -f environment.yml
15-
$ python setup.py develop
15+
$ pip install --editable .
1616

1717
Install additional dependencies::
1818

@@ -37,7 +37,7 @@ Before committing your changes, we ask that you install `pre-commit` in your env
3737
`Pre-commit` runs git hooks that ensure that your code resembles that of the project
3838
and catches and corrects any small errors or inconsistencies when you `git commit`::
3939

40-
$ conda install -c conda-forge pre_commit
40+
$ conda install -c conda-forge pre-commit
4141
$ pre-commit install
4242

4343
Write Documentation
@@ -63,3 +63,16 @@ Make a new version of Birdy in the following steps:
6363
See the bumpversion_ documentation for details.
6464

6565
.. _bumpversion: https://pypi.org/project/bumpversion/
66+
67+
Release a new version
68+
=====================
69+
70+
Leveraging GitHub Workflows, maintainers can release new versions of Birdy automatically:
71+
72+
* Ensure that the changelog and version on the main development branch have been updated to reflect the new version.
73+
* Create a tag (`vX.Y.Z`) of the main development branch and push to the GitHub repository.
74+
* This will trigger a workflow that will attempt to build Birdy and publish it to TestPyPI.
75+
* When this actions succeeds, be sure to verify on TestPyPI that the package reflects changes.
76+
* On GitHub, a maintainer can then publish a new version using the newly created tag.
77+
* This will trigger a workflow that will attempt to build Birdy and publish it to PyPI.
78+
* Be warned that once published to PyPI, a version number can never be overwritten! Bad versions may only be `yanked <https://pypi.org/help/#yanked>`_.

‎docs/source/installation.rst

+32-16
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,23 @@
44
Installation
55
************
66

7-
Install from Anaconda
8-
=====================
7+
Install from PyPI
8+
=================
9+
10+
|pypi|
911

10-
.. image:: https://anaconda.org/conda-forge/birdy/badges/installer/conda.svg
11-
:target: https://anaconda.org/conda-forge/birdy
12-
:alt: Ananconda Install
12+
.. code-block:: console
13+
14+
$ pip install birdhouse-birdy
1315
14-
.. image:: https://anaconda.org/conda-forge/birdy/badges/version.svg
15-
:target: https://anaconda.org/conda-forge/birdy
16-
:alt: Anaconda Version
16+
Install from Anaconda
17+
=====================
1718

18-
.. image:: https://anaconda.org/conda-forge/birdy/badges/downloads.svg
19-
:target: https://anaconda.org/conda-forge/birdy
20-
:alt: Anaconda Downloads
19+
|conda install| |conda version| |conda downloads|
2120

2221
.. code-block:: console
2322
24-
$ conda install -c conda-forge birdy
23+
$ conda install -c conda-forge birdy
2524
2625
Install from GitHub
2726
===================
@@ -30,7 +29,24 @@ Check out code from the birdy GitHub repo and start the installation:
3029

3130
.. code-block:: console
3231
33-
$ git clone https://github.com/bird-house/birdy.git
34-
$ cd birdy
35-
$ conda env create -f environment.yml
36-
$ python setup.py install
32+
$ git clone https://github.com/bird-house/birdy.git
33+
$ cd birdy
34+
$ conda env create -f environment.yml
35+
$ python setup.py install
36+
37+
38+
.. |pypi| image:: https://img.shields.io/pypi/v/birdhouse-birdy.svg
39+
:target: https://pypi.python.org/pypi/birdhouse-birdy
40+
:alt: Python Package Index Build
41+
42+
.. |conda install| image:: https://anaconda.org/conda-forge/birdy/badges/installer/conda.svg
43+
:target: https://anaconda.org/conda-forge/birdy
44+
:alt: Anaconda Install
45+
46+
.. |conda version| image:: https://anaconda.org/conda-forge/birdy/badges/version.svg
47+
:target: https://anaconda.org/conda-forge/birdy
48+
:alt: Anaconda Version
49+
50+
.. |conda downloads| image:: https://anaconda.org/conda-forge/birdy/badges/downloads.svg
51+
:target: https://anaconda.org/conda-forge/birdy
52+
:alt: Anaconda Downloads

‎setup.cfg

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[bumpversion]
2-
current_version = 0.8.2
2+
current_version = 0.8.3
33
commit = True
4-
tag = True
4+
tag = False
55

66
[metadata]
77
description-file = README.rst
@@ -21,7 +21,9 @@ replace = {new_version}
2121
[tool:pytest]
2222
python_files = test_*.py
2323
testpaths = tests
24-
addopts = --strict --tb=native
24+
addopts =
25+
--strict
26+
--tb=native
2527
markers =
2628
online: mark test to need internet connection
2729
slow: mark test to be slow
@@ -41,3 +43,4 @@ exclude =
4143
[doc8]
4244
ignore-path = docs/build,docs/source/_templates,docs/source/_static
4345
max-line-length = 120
46+

0 commit comments

Comments
 (0)