Added command to output version

Avoid repetition when writing to file.

Added command to get the current version.

Also added version to output. This required changes in the tests
expected output files.

Added a way to easily update the version in tests.

Updated readme and usage documentation.

Added script to get the current version to be used in bootstrap.

.bumpversion.cfg

@@ -3,18 +3,10 @@ current_version = 0.1.0
 commit = True
 tag = True
 
-[bumpversion:file:setup.py]
-search = version='{current_version}'
-replace = version='{new_version}'
-
-[bumpversion:file:README.rst]
-search = v{current_version}.
-replace = v{new_version}.
-
 [bumpversion:file:docs/conf.py]
 search = version = release = '{current_version}'
 replace = version = release = '{new_version}'
 
-[bumpversion:file:src/smap/__init__.py]
+[bumpversion:file:src/smap/_version.py]
 search = __version__ = '{current_version}'
 replace = __version__ = '{new_version}'

.gitignore

@@ -32,6 +32,7 @@ pip-log.txt
 nosetests.xml
 coverage.xml
 htmlcov
+tests/data
 
 # Translations
 *.mo

MANIFEST.in

@@ -14,7 +14,8 @@ include README.rst
 include HISTORY.rst
 
 include Makefile
+include version.py
 
 include tox.ini .travis.yml
 
-global-exclude docs/_build* *.swp
+global-exclude docs/_build* *.swp tests/data

Makefile

@@ -32,6 +32,11 @@ help:
 ci-bootstrap: ci/bootstrap.py
 	python ci/bootstrap.py
 
+bootstrap-tests:
+	@SMAP_NAME_VERSION=`python version.py`; \
+	echo "Setting name and version in tests as $${SMAP_NAME_VERSION}"; \
+	$(MAKE) -C tests SMAP_NAME_VERSION=$${SMAP_NAME_VERSION}
+
 clean: clean-build clean-pyc clean-test clean-docs
 
 clean-build: ## remove build artifacts
@@ -51,6 +56,7 @@ clean-test: ## remove test and coverage artifacts
 	rm -fr .tox/
 	rm -f .coverage
 	rm -fr htmlcov/
+	rm -rf tests/data
 
 clean-docs: ## remove generated docs files
 	rm -rf dist/docs
@@ -59,7 +65,7 @@ clean-docs: ## remove generated docs files
 lint: ## check style with flake8
 	flake8 src/smap tests
 
-test: ## run tests quickly with the default Python
+test: bootstrap-tests## run tests quickly with the default Python
 	pytest -vv --ignore=src/
 
 test-all: tox.ini## run tests on every Python version with tox

README.rst

@@ -155,28 +155,34 @@ or (to check the content of a existing map)::
 
   $ smap check my.map
 
+or (to check the current version)::
+
+  $ smap version
+
 Long version
 ------------
 
 Running  ``smap -h`` will give::
 
-  usage: smap [-h] {update,new,check} ...
+  usage: smap [-h] {update,new,check,version} ...
   
   Helper tools for linker version script maintenance
   
   optional arguments:
-    -h, --help          show this help message and exit
+    -h, --help            show this help message and exit
   
   Subcommands:
-    {update,new,check}  These subcommands have their own set of options
-      update            Update the map file
-      new               Create a new map file
-      check             Check the map file
+    {update,new,check,version}
+                          These subcommands have their own set of options
+      update              Update the map file
+      new                 Create a new map file
+      check               Check the map file
+      version             Print version
   
   Call a subcommand passing '-h' to see its specific options
 
 Call a subcommand passing '-h' to see its specific options
-There are three subcommands, ``update``, ``new``, and ``check``
+There are four subcommands, ``update``, ``new``, ``check``, and ``version``
 
 Running ``smap update -h`` will give::
 
@@ -269,6 +275,13 @@ Running ``smap check -h`` will give::
     -l LOGFILE, --logfile LOGFILE
                           Log to this file
 
+Running ``smap version -h`` will give::
+
+  usage: smap version [-h]
+  
+  optional arguments:
+    -h, --help  show this help message and exit
+
 Import as a library:
 --------------------
 

ci/templates/tox.ini

@@ -24,6 +24,7 @@ deps =
     pyyaml
     cover: pytest-cov
 commands =
+    make bootstrap-tests
     nocov: {posargs:py.test -vv --ignore=src}
     cover: {posargs:py.test --cov --cov-report=term-missing -vv}
 

docs/Makefile

@@ -21,22 +21,29 @@ HELP_CHECK:
 	echo >> HELP_CHECK
 	smap check -h | sed -e 's/^/  /' >> HELP_CHECK
 
-usage: HELP HELP_NEW HELP_UPDATE HELP_CHECK
+HELP_VERSION:
+	echo 'Running ``$ smap version -h`` will give::' > HELP_VERSION
+	echo >> HELP_VERSION
+	smap version -h | sed -e 's/^/  /' >> HELP_VERSION
+
+usage: HELP HELP_NEW HELP_UPDATE HELP_CHECK HELP_VERSION
 	cp templates/usage.template usage.rst
 	sed -e '/HELP_PLACEHOLDER/ {' -e 'r HELP' -e 'd' -e '}' -i usage.rst
 	sed -e '/HELP_UPDATE_PLACEHOLDER/ {' -e 'r HELP_UPDATE' -e 'd' -e '}' -i usage.rst
 	sed -e '/HELP_NEW_PLACEHOLDER/ {' -e 'r HELP_NEW' -e 'd' -e '}' -i usage.rst
 	sed -e '/HELP_CHECK_PLACEHOLDER/ {' -e 'r HELP_CHECK' -e 'd' -e '}' -i usage.rst
+	sed -e '/HELP_VERSION_PLACEHOLDER/ {' -e 'r HELP_VERSION' -e 'd' -e '}' -i usage.rst
 
-readme: HELP HELP_NEW HELP_UPDATE HELP_CHECK
+readme: HELP HELP_NEW HELP_UPDATE HELP_CHECK HELP_VERSION
 	cp templates/readme.template readme.rst
 	sed -e '/HELP_PLACEHOLDER/ {' -e 'r HELP' -e 'd' -e '}' -i readme.rst
 	sed -e '/HELP_UPDATE_PLACEHOLDER/ {' -e 'r HELP_UPDATE' -e 'd' -e '}' -i readme.rst
 	sed -e '/HELP_NEW_PLACEHOLDER/ {' -e 'r HELP_NEW' -e 'd' -e '}' -i readme.rst
 	sed -e '/HELP_CHECK_PLACEHOLDER/ {' -e 'r HELP_CHECK' -e 'd' -e '}' -i readme.rst
+	sed -e '/HELP_VERSION_PLACEHOLDER/ {' -e 'r HELP_VERSION' -e 'd' -e '}' -i readme.rst
 
 .PHONY: clean
 
 clean:
-	rm -rf HELP HELP_NEW HELP_UPDATE HELP_CHECK
+	rm -rf HELP HELP_NEW HELP_UPDATE HELP_CHECK HELP_VERSION
 

docs/readme.rst

@@ -155,28 +155,34 @@ or (to check the content of a existing map)::
 
   $ smap check my.map
 
+or (to check the current version)::
+
+  $ smap version
+
 Long version
 ------------
 
 Running  ``smap -h`` will give::
 
-  usage: smap [-h] {update,new,check} ...
+  usage: smap [-h] {update,new,check,version} ...
   
   Helper tools for linker version script maintenance
   
   optional arguments:
-    -h, --help          show this help message and exit
+    -h, --help            show this help message and exit
   
   Subcommands:
-    {update,new,check}  These subcommands have their own set of options
-      update            Update the map file
-      new               Create a new map file
-      check             Check the map file
+    {update,new,check,version}
+                          These subcommands have their own set of options
+      update              Update the map file
+      new                 Create a new map file
+      check               Check the map file
+      version             Print version
   
   Call a subcommand passing '-h' to see its specific options
 
 Call a subcommand passing '-h' to see its specific options
-There are three subcommands, ``update``, ``new``, and ``check``
+There are four subcommands, ``update``, ``new``, ``check``, and ``version``
 
 Running ``smap update -h`` will give::
 
@@ -269,6 +275,13 @@ Running ``smap check -h`` will give::
     -l LOGFILE, --logfile LOGFILE
                           Log to this file
 
+Running ``smap version -h`` will give::
+
+  usage: smap version [-h]
+  
+  optional arguments:
+    -h, --help  show this help message and exit
+
 Import as a library:
 --------------------
 

docs/templates/readme.template

@@ -155,19 +155,25 @@ or (to check the content of a existing map)::
 
   $ smap check my.map
 
+or (to check the current version)::
+
+  $ smap version
+
 Long version
 ------------
 
 INCLUDE_HELP_PLACEHOLDER
 
 Call a subcommand passing '-h' to see its specific options
-There are three subcommands, ``update``, ``new``, and ``check``
+There are four subcommands, ``update``, ``new``, ``check``, and ``version``
 
-INCLUDE_HELP_UPDATE_PLACEHOLDER
+INCLUDE HELP_UPDATE_PLACEHOLDER
 
 INCLUDE HELP_NEW_PLACEHOLDER
 
-INCLUDE_HELP_CHECK_PLACEHOLDER
+INCLUDE HELP_CHECK_PLACEHOLDER
+
+INCLUDE HELP_VERSION_PLACEHOLDER
 
 Import as a library:
 --------------------

docs/templates/usage.template

@@ -41,19 +41,25 @@ or (to check the content of a existing map)::
 
   $ smap check my.map
 
+or (to check the current version)::
+
+  $ smap version
+
 Long version
 ------------
 
-INCLUDE_HELP_PLACEHOLDER
+INCLUDE HELP_PLACEHOLDER
 
 Call a subcommand passing '-h' to see its specific options
-There are three subcommands, ``update``, ``new``, and ``check``
+There are four subcommands, ``update``, ``new``, ``check``, and ``version``
 
-INCLUDE_HELP_UPDATE_PLACEHOLDER
+INCLUDE HELP_UPDATE_PLACEHOLDER
 
 INCLUDE HELP_NEW_PLACEHOLDER
 
-INCLUDE_HELP_CHECK_PLACEHOLDER
+INCLUDE HELP_CHECK_PLACEHOLDER
+
+INCLUDE HELP_VERSION_PLACEHOLDER
 
 Import as a library:
 --------------------

docs/usage.rst

@@ -41,28 +41,34 @@ or (to check the content of a existing map)::
 
   $ smap check my.map
 
+or (to check the current version)::
+
+  $ smap version
+
 Long version
 ------------
 
 Running  ``smap -h`` will give::
 
-  usage: smap [-h] {update,new,check} ...
+  usage: smap [-h] {update,new,check,version} ...
   
   Helper tools for linker version script maintenance
   
   optional arguments:
-    -h, --help          show this help message and exit
+    -h, --help            show this help message and exit
   
   Subcommands:
-    {update,new,check}  These subcommands have their own set of options
-      update            Update the map file
-      new               Create a new map file
-      check             Check the map file
+    {update,new,check,version}
+                          These subcommands have their own set of options
+      update              Update the map file
+      new                 Create a new map file
+      check               Check the map file
+      version             Print version
   
   Call a subcommand passing '-h' to see its specific options
 
 Call a subcommand passing '-h' to see its specific options
-There are three subcommands, ``update``, ``new``, and ``check``
+There are four subcommands, ``update``, ``new``, ``check``, and ``version``
 
 Running ``smap update -h`` will give::
 
@@ -155,6 +161,13 @@ Running ``smap check -h`` will give::
     -l LOGFILE, --logfile LOGFILE
                           Log to this file
 
+Running ``smap version -h`` will give::
+
+  usage: smap version [-h]
+  
+  optional arguments:
+    -h, --help  show this help message and exit
+
 Import as a library:
 --------------------
 

setup.py

@@ -3,12 +3,17 @@
 
 """The setup script."""
 
+import os
 from glob import glob
 from os.path import basename
 from os.path import splitext
 
 from setuptools import find_packages
 from setuptools import setup
+from version import get_version
+
+package_name = "symver-smap"
+here = os.path.abspath(os.path.dirname(__file__))
 
 with open('README.rst') as readme_file:
     readme = readme_file.read()
@@ -22,6 +27,8 @@
 
 test_requirements = ['pytest', 'pyyaml', 'pytest-cov', 'pytest-console-scripts']
 
+version = get_version()
+
 setup(
     author="Anderson Toshiyuki Sasaki",
     author_email='ansasaki@redhat.com',
@@ -44,17 +51,18 @@
     long_description=readme + '\n\n' + history,
     include_package_data=True,
     keywords='symver smap symbol version versioning linker script library maintenance',
-    name='symver-smap',
+    name=package_name,
     packages=find_packages('src'),
     package_dir={'': 'src'},
-    py_modules=[splitext(basename(path))[0] for path in glob('src/smap/*.py')],
+    py_modules=[splitext(basename(path))[0] for path in glob(
+        os.path.join(here, 'src', 'smap', '*.py'))],
     entry_points={
         'console_scripts': ['smap=smap.main:main']
     },
     setup_requires=setup_requirements,
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/ansasaki/smap',
-    version='0.1.0',
+    version=version,
     zip_safe=False,
 )

src/smap/__init__.py

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+# flake8: noqa
+from ._version import __version__
 
 """Top-level package for smap."""
 
 __author__ = """Anderson Toshiyuki Sasaki"""
 __email__ = 'ansasaki@redhat.com'
-__version__ = '0.1.0'

src/smap/_version.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'