Skip to content

Commit

Permalink
Fix documentation and release action (#59)
Browse files Browse the repository at this point in the history
* Add details to pyproject.toml and fix docs dependency

* restricted publish to when releases are published
  • Loading branch information
OliverSherouse authored Jun 28, 2020
1 parent 51e5433 commit 27c3485
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 9 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ on:
release:
branches:
- master
types:
- publish
jobs:
test:
publish:
name: Publish
runs-on: ubuntu-latest
steps:
Expand Down
3 changes: 2 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ version: 2
formats: all
python:
install:
- path: .
- method: pip
path: .
extra_requirements:
- docs
21 changes: 15 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "wbdata"
version = "0.3.0"
version = "0.3.0.post"
description = "A library to access World Bank data"
authors = ["Oliver Sherouse <[email protected]>"]
license = "GPL-2.0+"
Expand All @@ -12,25 +12,34 @@ classifiers = [
"Topic :: Scientific/Engineering",
]

repository = "https://github.com/OliverSherouse/wbdata"
documentation = "https://wbdata.readthedocs.io/"
keywords = ["World Bank", "data", "economics"]

[tool.poetry.dependencies]
python = ">=3.6"
decorator = ">=4.0"
requests = ">=2.0"
pandas = {version = ">=0.17", optional=true}
sphinx = {version = ">=2.2", optional=true}
tabulate = ">=0.8.5"
appdirs = "^1.4"
appdirs = ">=1.4"

pandas = {version = ">=0.17", optional=true}
sphinx = {version = "^3.0.3", optional=true}
recommonmark = {version = "^0.6.0", optional=true}
ipython = {version = "^7.16.1", optional=true}

[tool.poetry.extras]
pandas = ["pandas"]
docs = ["sphinx", "recommonmark", "ipython"]

[tool.poetry.dev-dependencies]
pytest-flake8 = ">=1.0"
ipython = ">=7.8"
pytest-flake8 = "^=1.0.6"
ipython = "^=7.16.1"
flake8-bugbear = "^20.1.4"
sphinx = "^3.0.3"
recommonmark = "^0.6.0"
flake8 = "^3.8.3"
pytest = "^5.4.3"

[build-system]
requires = ["poetry>=0.12"]
Expand Down
2 changes: 1 addition & 1 deletion wbdata/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
wbdata: A wrapper for the World Bank API
"""
__version__ = "0.3.0"
__version__ = "0.3.0.post"

from .api import ( # noqa: F401
get_country,
Expand Down

0 comments on commit 27c3485

Please sign in to comment.