docs: use markdown for readme file

per python 3 effort

.gitignore

@@ -1 +1,4 @@
+*~
+*.pyc
+dist/
 rattail_cognitive.egg-info

CHANGELOG.md

@@ -0,0 +1,60 @@
+
+# Changelog
+All notable changes to rattail_cognitive will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+
+## v0.4.0 (2024-07-09)
+
+### Feat
+
+- switch from setup.cfg to pyproject.toml + hatchling
+
+## 0.3.6 (2023-06-01)
+
+* Replace ``setup.py`` contents with ``setup.cfg``.
+
+
+## 0.3.5 (2019-01-21)
+
+* Remove unused reference to ``cStringIO``.
+
+
+## 0.3.4 (2017-07-07)
+
+* Switch license to GPL v3 (no longer Affero)
+
+
+## 0.3.3
+
+* Refactor some config usage per rattail changes.
+
+
+## 0.3.2
+
+* Fix broken barcode commands.
+    
+  UPC wasn't working, and EAN wasn't even being attempted...
+
+
+## 0.3.1
+
+* Refactor ``rattail.hw.cognitive`` -> ``rattail_cognitive``.
+
+
+## 0.3a3
+
+- [general] Fixed namespace package declaration.
+
+- [general] Added initial Fabric script.
+
+
+## 0.3a2
+
+- Tweaked default label format.
+
+## 0.3a1
+
+-  Initial port to Rattail v0.3.

CHANGES.rst

@@ -1,47 +0,0 @@
-
-CHANGELOG
-=========
-
-0.3.4 (2017-07-07)
-------------------
-
-* Switch license to GPL v3 (no longer Affero)
-
-
-0.3.3
------
-
-* Refactor some config usage per rattail changes.
-
-
-0.3.2
------
-
-* Fix broken barcode commands.
-    
-  UPC wasn't working, and EAN wasn't even being attempted...
-
-
-0.3.1
------
-
-* Refactor ``rattail.hw.cognitive`` -> ``rattail_cognitive``.
-
-
-0.3a3
------
-
-- [general] Fixed namespace package declaration.
-
-- [general] Added initial Fabric script.
-
-
-0.3a2
------
-
-- Tweaked default label format.
-
-0.3a1
------
-
--  Initial port to Rattail v0.3.

README.md

@@ -0,0 +1,11 @@
+
+# rattail-cognitive
+
+Rattail is a retail software framework, released under the GNU General Public
+License.
+
+This package contains hardware interfaces for
+[Cognitive](http://www.cognitive.com/) devices.
+
+Please see Rattail's [home page](https://rattailproject.org/) for more
+information.

README.txt

@@ -1,13 +0,0 @@
-
-rattail-cognitive
-=================
-
-Rattail is a retail software framework, released under the GNU General Public
-License.
-
-This package contains hardware interfaces for `Cognitive`_ devices.
-
-Please see Rattail's `home page`_ for more information.
-
-.. _Cognitive: http://www.cognitive.com/
-.. _home page: https://rattailproject.org/

pyproject.toml

@@ -0,0 +1,44 @@
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[project]
+name = "rattail_cognitive"
+version = "0.4.0"
+description = "Hardware Interfaces for Cognitive Devices"
+readme = "README.md"
+authors = [{name = "Lance Edgar", email = "lance@edbob.org"}]
+license = {text = "GNU GPL v3+"}
+classifiers = [
+        "Development Status :: 3 - Alpha",
+        "Environment :: Console",
+        "Environment :: Web Environment",
+        "Environment :: Win32 (MS Windows)",
+        "Environment :: X11 Applications",
+        "Intended Audience :: Developers",
+        "Intended Audience :: System Administrators",
+        "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+        "Natural Language :: English",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Topic :: Office/Business",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+        "rattail",
+]
+
+
+[project.urls]
+Homepage = "https://rattailproject.org"
+Repository = "https://kallithea.rattailproject.org/rattail-project-contrib/rattail-cognitive"
+Changelog = "https://kallithea.rattailproject.org/rattail-project-contrib/rattail-cognitive/files/master/CHANGELOG.md"
+
+
+[tool.commitizen]
+version_provider = "pep621"
+tag_format = "v$version"
+update_changelog_on_bump = true

rattail_cognitive/_version.py

@@ -1,3 +1,6 @@
 # -*- coding: utf-8; -*-
 
-__version__ = '0.3.4'
+from importlib.metadata import version
+
+
+__version__ = version('rattail_cognitive')

rattail_cognitive/labels.py

@@ -2,7 +2,7 @@
 ################################################################################
 #
 #  Rattail -- Retail Software Framework
-#  Copyright © 2010-2017 Lance Edgar
+#  Copyright © 2010-2018 Lance Edgar
 #
 #  This file is part of Rattail.
 #
@@ -24,9 +24,7 @@
 Label Printing
 """
 
-from __future__ import unicode_literals
-
-from cStringIO import StringIO
+from __future__ import unicode_literals, absolute_import
 
 from rattail import labels
 

setup.py

@@ -1,101 +0,0 @@
-# -*- coding: utf-8; -*-
-################################################################################
-#
-#  Rattail -- Retail Software Framework
-#  Copyright © 2010-2017 Lance Edgar
-#
-#  This file is part of Rattail.
-#
-#  Rattail is free software: you can redistribute it and/or modify it under the
-#  terms of the GNU General Public License as published by the Free Software
-#  Foundation, either version 3 of the License, or (at your option) any later
-#  version.
-#
-#  Rattail is distributed in the hope that it will be useful, but WITHOUT ANY
-#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-#  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-#  details.
-#
-#  You should have received a copy of the GNU General Public License along with
-#  Rattail.  If not, see <http://www.gnu.org/licenses/>.
-#
-################################################################################
-
-
-import os.path
-from setuptools import setup, find_packages
-
-
-here = os.path.abspath(os.path.dirname(__file__))
-exec(open(os.path.join(here, 'rattail_cognitive', '_version.py')).read())
-README = open(os.path.join(here, 'README.txt')).read()
-CHANGES = open(os.path.join(here, 'CHANGES.rst')).read()
-
-
-requires = [
-    #
-    # Version numbers within comments below have specific meanings.
-    # Basically the 'low' value is a "soft low," and 'high' a "soft high."
-    # In other words:
-    #
-    # If either a 'low' or 'high' value exists, the primary point to be
-    # made about the value is that it represents the most current (stable)
-    # version available for the package (assuming typical public access
-    # methods) whenever this project was started and/or documented.
-    # Therefore:
-    #
-    # If a 'low' version is present, you should know that attempts to use
-    # versions of the package significantly older than the 'low' version
-    # may not yield happy results.  (A "hard" high limit may or may not be
-    # indicated by a true version requirement.)
-    #
-    # Similarly, if a 'high' version is present, and especially if this
-    # project has laid dormant for a while, you may need to refactor a bit
-    # when attempting to support a more recent version of the package.  (A
-    # "hard" low limit should be indicated by a true version requirement
-    # when a 'high' version is present.)
-    #
-    # In any case, developers and other users are encouraged to play
-    # outside the lines with regard to these soft limits.  If bugs are
-    # encountered then they should be filed as such.
-    #
-    # package                           # low                   high
-
-    'rattail>=0.3a6',                   #                       0.3a7.dev
-    ]
-
-
-setup(
-    name = "rattail_cognitive",
-    version = __version__,
-    author = "Lance Edgar",
-    author_email = "lance@edbob.org",
-    url = "http://rattailproject.org/",
-    license = "GNU GPL v3",
-    description = "Hardware Interfaces for Cognitive Devices",
-    long_description = README + '\n\n' +  CHANGES,
-
-    classifiers = [
-        'Development Status :: 3 - Alpha',
-        'Environment :: Console',
-        'Environment :: Web Environment',
-        'Environment :: Win32 (MS Windows)',
-        'Environment :: X11 Applications',
-        'Intended Audience :: Developers',
-        'Intended Audience :: System Administrators',
-        'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
-        'Natural Language :: English',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python',
-        'Programming Language :: Python :: 2.6',
-        'Programming Language :: Python :: 2.7',
-        'Topic :: Office/Business',
-        'Topic :: Software Development :: Libraries :: Python Modules',
-        ],
-
-    install_requires = requires,
-
-    packages = find_packages(),
-    include_package_data = True,
-    zip_safe = False,
-    )

tasks.py

@@ -2,7 +2,7 @@
 ################################################################################
 #
 #  Rattail -- Retail Software Framework
-#  Copyright © 2010-2017 Lance Edgar
+#  Copyright © 2010-2024 Lance Edgar
 #
 #  This file is part of Rattail.
 #
@@ -20,16 +20,26 @@
 #  Rattail.  If not, see <http://www.gnu.org/licenses/>.
 #
 ################################################################################
+"""
+Tasks for rattail-cognitive
+"""
 
+import os
 import shutil
 
-from fabric.api import *
+from invoke import task
 
 
 @task
-def release():
+def release(c):
     """
-    Release a new version of 'rattail_cognitive'.
+    Release a new version of `rattail`.
     """
-    shutil.rmtree('rattail_cognitive.egg-info')
-    local('python setup.py sdist --formats=gztar register upload')
+    if os.path.exists('rattail_cognitive.egg-info'):
+        shutil.rmtree('rattail_cognitive.egg-info')
+    if os.path.exists('dist'):
+        shutil.rmtree('dist')
+
+    c.run('python -m build --sdist')
+
+    c.run('twine upload dist/*')