Merge pull request #146 from python-escpos/add-version-to-module
add version-strings into the module
This commit is contained in:
commit
457c62cc7f
|
@ -17,6 +17,8 @@ I have:
|
||||||
<!-- Replace examples with your info -->
|
<!-- Replace examples with your info -->
|
||||||
**Printer:** Manufacturer Model XVI
|
**Printer:** Manufacturer Model XVI
|
||||||
|
|
||||||
|
<!-- since version 2.0.1 you can type 'python-escpos version' in your shell.
|
||||||
|
Alternatively you could use '__version__' in module escpos. -->
|
||||||
**python-escpos version:** 0.0.0
|
**python-escpos version:** 0.0.0
|
||||||
|
|
||||||
**python version:** 0.0
|
**python version:** 0.0
|
||||||
|
|
|
@ -17,6 +17,7 @@ temp
|
||||||
build/
|
build/
|
||||||
dist/
|
dist/
|
||||||
.coverage
|
.coverage
|
||||||
|
src/escpos/version.py
|
||||||
|
|
||||||
# testing temporary directories
|
# testing temporary directories
|
||||||
test/test-cli-output/
|
test/test-cli-output/
|
||||||
|
|
|
@ -10,6 +10,7 @@ changes
|
||||||
- packaging: configured the coverage-analysis codecov.io
|
- packaging: configured the coverage-analysis codecov.io
|
||||||
- GitHub: improved issues-template
|
- GitHub: improved issues-template
|
||||||
- documentation: add troubleshooting tip to network-interface
|
- documentation: add troubleshooting tip to network-interface
|
||||||
|
- the module, cli and documentation is now aware of the version of python-escpos
|
||||||
|
|
||||||
contributors
|
contributors
|
||||||
^^^^^^^^^^^^
|
^^^^^^^^^^^^
|
||||||
|
|
15
doc/conf.py
15
doc/conf.py
|
@ -15,7 +15,10 @@
|
||||||
import sys
|
import sys
|
||||||
import os
|
import os
|
||||||
on_rtd = os.getenv('READTHEDOCS') == 'True'
|
on_rtd = os.getenv('READTHEDOCS') == 'True'
|
||||||
from setuptools_scm import get_version
|
if on_rtd:
|
||||||
|
import escpos
|
||||||
|
else:
|
||||||
|
from setuptools_scm import get_version
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
# add these directories to sys.path here. If the directory is relative to the
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
@ -70,10 +73,14 @@ copyright = u'2016, Manuel F Martinez and others'
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
# built documents.
|
# built documents.
|
||||||
#
|
#
|
||||||
|
if on_rtd:
|
||||||
|
# The full version, including alpha/beta/rc tags.
|
||||||
|
release = escpos.__version__
|
||||||
|
else:
|
||||||
|
# locally setuptools_scm should work
|
||||||
|
release = get_version(root=root)
|
||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = get_version(root=root)
|
version = '.'.join(release.split('.')[:2]) # The short X.Y version.
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = version
|
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
|
|
17
setup.py
17
setup.py
|
@ -45,9 +45,24 @@ class Tox(test_command):
|
||||||
errno = tox.cmdline(args=args)
|
errno = tox.cmdline(args=args)
|
||||||
sys.exit(errno)
|
sys.exit(errno)
|
||||||
|
|
||||||
|
|
||||||
|
setuptools_scm_template = """\
|
||||||
|
# coding: utf-8
|
||||||
|
# file generated by setuptools_scm
|
||||||
|
# don't change, don't track in version control
|
||||||
|
from __future__ import unicode_literals
|
||||||
|
|
||||||
|
version = '{version}'
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='python-escpos',
|
name='python-escpos',
|
||||||
use_scm_version=True,
|
use_scm_version={
|
||||||
|
'write_to': 'src/escpos/version.py',
|
||||||
|
'write_to_template': setuptools_scm_template,
|
||||||
|
},
|
||||||
url='https://github.com/python-escpos/python-escpos',
|
url='https://github.com/python-escpos/python-escpos',
|
||||||
download_url='https://github.com/python-escpos/python-escpos/archive/master.zip',
|
download_url='https://github.com/python-escpos/python-escpos/archive/master.zip',
|
||||||
description='Python library to manipulate ESC/POS Printers',
|
description='Python library to manipulate ESC/POS Printers',
|
||||||
|
|
|
@ -1 +1,19 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""
|
||||||
|
python-escpos enables you to manipulate escpos-printers
|
||||||
|
"""
|
||||||
|
from __future__ import absolute_import
|
||||||
|
from __future__ import division
|
||||||
|
from __future__ import print_function
|
||||||
|
from __future__ import unicode_literals
|
||||||
|
|
||||||
__all__ = ["constants", "escpos", "exceptions", "printer"]
|
__all__ = ["constants", "escpos", "exceptions", "printer"]
|
||||||
|
|
||||||
|
try:
|
||||||
|
from .version import version as __version__ # noqa
|
||||||
|
except ImportError: # pragma: no cover
|
||||||
|
raise ImportError(
|
||||||
|
'Failed to find (autogenerated) version.py. '
|
||||||
|
'This might be because you are installing from GitHub\'s tarballs, '
|
||||||
|
'use the PyPI ones.'
|
||||||
|
)
|
||||||
|
|
|
@ -17,6 +17,7 @@ import argparse
|
||||||
import sys
|
import sys
|
||||||
import six
|
import six
|
||||||
from . import config
|
from . import config
|
||||||
|
from . import version
|
||||||
|
|
||||||
|
|
||||||
# Must be defined before it's used in DEMO_FUNCTIONS
|
# Must be defined before it's used in DEMO_FUNCTIONS
|
||||||
|
@ -448,14 +449,17 @@ def main():
|
||||||
# Allow config file location to be passed
|
# Allow config file location to be passed
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
'-c', '--config',
|
'-c', '--config',
|
||||||
help='Altnerate path to the configuration file',
|
help='Alternate path to the configuration file',
|
||||||
)
|
)
|
||||||
|
|
||||||
# Everything interesting runs off of a subparser so we can use the format
|
# Everything interesting runs off of a subparser so we can use the format
|
||||||
# cli [subparser] -args
|
# cli [subparser] -args
|
||||||
command_subparsers = parser.add_subparsers(
|
command_subparsers = parser.add_subparsers(
|
||||||
title='ESCPOS Command',
|
title='ESCPOS Command',
|
||||||
|
dest='parser',
|
||||||
)
|
)
|
||||||
|
# fix inconsistencies in the behaviour of some versions of argparse
|
||||||
|
command_subparsers.required = False # force 'required' testing
|
||||||
|
|
||||||
# Build the ESCPOS command arguments
|
# Build the ESCPOS command arguments
|
||||||
for command in ESCPOS_COMMANDS:
|
for command in ESCPOS_COMMANDS:
|
||||||
|
@ -491,6 +495,10 @@ def main():
|
||||||
action='store_true',
|
action='store_true',
|
||||||
)
|
)
|
||||||
|
|
||||||
|
parser_command_version = command_subparsers.add_parser('version',
|
||||||
|
help='Print the version of python-escpos')
|
||||||
|
parser_command_version.set_defaults(version=True)
|
||||||
|
|
||||||
# Get only arguments actually passed
|
# Get only arguments actually passed
|
||||||
args_dict = vars(parser.parse_args())
|
args_dict = vars(parser.parse_args())
|
||||||
if not args_dict:
|
if not args_dict:
|
||||||
|
@ -498,6 +506,12 @@ def main():
|
||||||
sys.exit()
|
sys.exit()
|
||||||
command_arguments = dict([k, v] for k, v in six.iteritems(args_dict) if v is not None)
|
command_arguments = dict([k, v] for k, v in six.iteritems(args_dict) if v is not None)
|
||||||
|
|
||||||
|
# If version should be printed, do this, then exit
|
||||||
|
print_version = command_arguments.pop('version', None)
|
||||||
|
if print_version:
|
||||||
|
print(version.version)
|
||||||
|
sys.exit()
|
||||||
|
|
||||||
# If there was a config path passed, grab it
|
# If there was a config path passed, grab it
|
||||||
config_path = command_arguments.pop('config', None)
|
config_path = command_arguments.pop('config', None)
|
||||||
|
|
||||||
|
@ -511,6 +525,9 @@ def main():
|
||||||
|
|
||||||
target_command = command_arguments.pop('func')
|
target_command = command_arguments.pop('func')
|
||||||
|
|
||||||
|
# remove helper-argument 'parser' from dict
|
||||||
|
command_arguments.pop('parser', None)
|
||||||
|
|
||||||
if hasattr(printer, target_command):
|
if hasattr(printer, target_command):
|
||||||
# print command with args
|
# print command with args
|
||||||
getattr(printer, target_command)(**command_arguments)
|
getattr(printer, target_command)(**command_arguments)
|
||||||
|
|
|
@ -11,6 +11,7 @@ import os
|
||||||
import sys
|
import sys
|
||||||
from scripttest import TestFileEnvironment
|
from scripttest import TestFileEnvironment
|
||||||
from nose.tools import assert_equals
|
from nose.tools import assert_equals
|
||||||
|
import escpos
|
||||||
|
|
||||||
TEST_DIR = os.path.abspath('test/test-cli-output')
|
TEST_DIR = os.path.abspath('test/test-cli-output')
|
||||||
|
|
||||||
|
@ -29,7 +30,7 @@ printer:
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
class TestCLI:
|
class TestCLI():
|
||||||
""" Contains setups, teardowns, and tests for CLI
|
""" Contains setups, teardowns, and tests for CLI
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
@ -60,8 +61,7 @@ class TestCLI:
|
||||||
)
|
)
|
||||||
|
|
||||||
self.default_args = (
|
self.default_args = (
|
||||||
sys.executable,
|
'python-escpos',
|
||||||
'-mescpos.cli',
|
|
||||||
'-c',
|
'-c',
|
||||||
CONFIGFILE,
|
CONFIGFILE,
|
||||||
)
|
)
|
||||||
|
@ -79,10 +79,16 @@ class TestCLI:
|
||||||
|
|
||||||
def test_cli_help(self):
|
def test_cli_help(self):
|
||||||
""" Test getting help from cli """
|
""" Test getting help from cli """
|
||||||
result = self.env.run(sys.executable, '-mescpos.cli', '-h')
|
result = self.env.run('python-escpos', '-h')
|
||||||
assert not result.stderr
|
assert not result.stderr
|
||||||
assert 'usage' in result.stdout
|
assert 'usage' in result.stdout
|
||||||
|
|
||||||
|
def test_cli_version(self):
|
||||||
|
""" Test the version string """
|
||||||
|
result = self.env.run('python-escpos', 'version')
|
||||||
|
assert not result.stderr
|
||||||
|
assert_equals(escpos.__version__, result.stdout.strip())
|
||||||
|
|
||||||
def test_cli_text(self):
|
def test_cli_text(self):
|
||||||
""" Make sure text returns what we sent it """
|
""" Make sure text returns what we sent it """
|
||||||
test_text = 'this is some text'
|
test_text = 'this is some text'
|
||||||
|
|
Loading…
Reference in New Issue