Skip to content

Commit db1e83c

Browse files
committed
Improve tooling
1 parent f35b368 commit db1e83c

File tree

5 files changed

+48
-14
lines changed

5 files changed

+48
-14
lines changed

CHANGES.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ Minesoft PatBase REST API client CHANGES
55

66
development
77
===========
8+
9+
2018-06-12 0.1.0
10+
================
811
- Persistently store user credentials for convenient usage with subsequent API operations
912
- Add basic implementation of PatBase API methods "query" and "searchresults"
10-
13+
- Improve tooling
1114

1215
2018-06-11 0.0.0
1316
================

Makefile

Lines changed: 34 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,48 @@
1+
# ------
2+
# Common
3+
# ------
4+
5+
$(eval venvpath := .venv_util)
6+
$(eval pip := $(venvpath)/bin/pip)
7+
$(eval python := $(venvpath)/bin/python)
8+
$(eval bumpversion := $(venvpath)/bin/bumpversion)
9+
$(eval twine := $(venvpath)/bin/twine)
10+
$(eval sphinx := $(venvpath)/bin/sphinx-build)
11+
12+
setup-virtualenv:
13+
@test -e $(python) || `command -v virtualenv` --python=`command -v python` --no-site-packages $(venvpath)
14+
15+
16+
# -------
17+
# Release
18+
# -------
19+
20+
setup-release: setup-virtualenv
21+
$(pip) install --quiet --requirement requirements-release.txt
22+
123
bumpversion:
2-
bumpversion $(bump)
24+
$(bumpversion) $(bump)
325

426
push:
527
git push && git push --tags
628

729
sdist:
8-
python setup.py sdist
30+
$(python) setup.py sdist
931

1032
upload:
11-
twine upload --skip-existing dist/minesoft-patbase-client-*.tar.gz
33+
$(twine) upload --skip-existing dist/*.tar.gz
1234

1335
# make release bump=minor (major,minor,patch)
14-
release: bumpversion push sdist upload
36+
release: setup-release bumpversion push sdist upload
37+
1538

39+
# -------------
40+
# Documentation
41+
# -------------
1642

17-
docs-virtualenv:
18-
$(eval venvpath := ".venv_sphinx")
19-
@test -e $(venvpath)/bin/python || `command -v virtualenv` --python=`command -v python` --no-site-packages $(venvpath)
20-
@$(venvpath)/bin/pip install --requirement requirements-docs.txt
43+
setup-docs: setup-virtualenv
44+
$(pip) install --quiet --requirement requirements-docs.txt
2145

22-
docs-html: docs-virtualenv
23-
$(eval venvpath := ".venv_sphinx")
46+
docs-html: setup-docs
2447
touch docs/index.rst
25-
export SPHINXBUILD="`pwd`/$(venvpath)/bin/sphinx-build"; cd docs; make html
48+
export SPHINXBUILD="`pwd`/$(sphinx)"; cd docs; make html

docs/usage.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
################################
2+
Usage of PatBase REST API client
3+
################################
4+
5+
TBD.

requirements-docs.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
Sphinx==1.6.4
2-
sphinx_rtd_theme==0.2.5b1
1+
Sphinx==1.7.5
2+
sphinx_rtd_theme==0.4.0

requirements-release.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
bumpversion==0.5.3
2+
twine==1.11.0
3+
keyring==12.2.1

0 commit comments

Comments
 (0)