diff --git a/.gitignore b/.gitignore index 21277ed..129bcb9 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ +*~ +*.pyc +dist/ rattail_harvest.egg-info/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 62ab236..c1c7891 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,28 @@ All notable changes to rattail-harvest 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.3.2 (2024-08-18) + +### Fix + +- avoid deprecated base class for config extension + +## v0.3.1 (2024-07-01) + +### Fix + +- remove legacy command definitions + +## v0.3.0 (2024-06-10) + +### Feat + +- switch from setup.cfg to pyproject.toml + hatchling + +## [0.2.1] - 2024-06-06 +### Changed +- Add alembic scripts to project manifest. + ## [0.2.0] - 2024-06-06 ### Changed - Add typer equivalents for `rattail` commands. diff --git a/MANIFEST.in b/MANIFEST.in index cf92731..d765c69 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,5 @@ include *.md include *.rst + recursive-include rattail_harvest/db/alembic *.mako +recursive-include rattail_harvest/db/alembic *.py diff --git a/README.md b/README.md new file mode 100644 index 0000000..3a6e08e --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ + +# rattail-harvest + +Rattail is a retail software framework, released under the GNU General +Public License. + +This package contains software interfaces for +[Harvest](https://www.getharvest.com/). + +Please see the [Rattail Project](https://rattailproject.org/) for more +information. diff --git a/README.rst b/README.rst deleted file mode 100644 index ab02203..0000000 --- a/README.rst +++ /dev/null @@ -1,14 +0,0 @@ - -rattail-harvest -=============== - -Rattail is a retail software framework, released under the GNU General -Public License. - -This package contains software interfaces for `Harvest`_. - -.. _`Harvest`: https://www.getharvest.com/ - -Please see the `Rattail Project`_ for more information. - -.. _`Rattail Project`: https://rattailproject.org/ diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..8002dd2 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,53 @@ + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + + +[project] +name = "rattail-harvest" +version = "0.3.2" +description = "Rattail integration package for Harvest" +readme = "README.md" +authors = [{name = "Lance Edgar", email = "lance@edbob.org"}] +license = {text = "GNU GPL v3+"} +classifiers = [ + "Development Status :: 3 - Alpha", + "Environment :: Console", + "Intended Audience :: Developers", + "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 = [ + "invoke", + "rattail[db]", +] + + +[project.urls] +Homepage = "https://rattailproject.org" +Repository = "https://forgejo.wuttaproject.org/rattail/rattail-harvest" +Changelog = "https://forgejo.wuttaproject.org/rattail/rattail-harvest/src/branch/master/CHANGELOG.md" + + +[project.entry-points."rattail.typer_imports"] +rattail_harvest = "rattail_harvest.commands" + + +[project.entry-points."rattail.config.extensions"] +rattail_harvest = "rattail_harvest.config:RattailHarvestExtension" + + +[project.entry-points."rattail.importing"] +"to_rattail.from_harvest.import" = "rattail_harvest.importing.harvest:FromHarvestToRattail" + + +[tool.commitizen] +version_provider = "pep621" +tag_format = "v$version" +update_changelog_on_bump = true diff --git a/rattail_harvest/_version.py b/rattail_harvest/_version.py index 08b390b..885cd51 100644 --- a/rattail_harvest/_version.py +++ b/rattail_harvest/_version.py @@ -1,3 +1,6 @@ # -*- coding: utf-8; -*- -__version__ = '0.2.0' +from importlib.metadata import version + + +__version__ = version('rattail-harvest') diff --git a/rattail_harvest/commands.py b/rattail_harvest/commands.py index 7cc804b..c54848c 100644 --- a/rattail_harvest/commands.py +++ b/rattail_harvest/commands.py @@ -26,7 +26,7 @@ rattail-harvest commands import typer -from rattail.commands import rattail_typer, ImportSubcommand +from rattail.commands import rattail_typer from rattail.commands.typer import importer_command, typer_get_runas_user from rattail.commands.importing import ImportCommandHandler @@ -46,12 +46,3 @@ def import_harvest( config, import_handler_key='to_rattail.from_harvest.import') kwargs['user'] = typer_get_runas_user(ctx) handler.run(kwargs, progress=progress) - - -class ImportHarvest(ImportSubcommand): - """ - Import data to Rattail, from Harvest API - """ - name = 'import-harvest' - description = __doc__.strip() - handler_key = 'to_rattail.from_harvest.import' diff --git a/rattail_harvest/config.py b/rattail_harvest/config.py index 9fedb3e..93cc4d1 100644 --- a/rattail_harvest/config.py +++ b/rattail_harvest/config.py @@ -2,7 +2,7 @@ ################################################################################ # # Rattail -- Retail Software Framework -# Copyright © 2010-2022 Lance Edgar +# Copyright © 2010-2024 Lance Edgar # # This file is part of Rattail. # @@ -24,10 +24,10 @@ Config Extension """ -from rattail.config import ConfigExtension +from wuttjamaican.conf import WuttaConfigExtension -class RattailHarvestExtension(ConfigExtension): +class RattailHarvestExtension(WuttaConfigExtension): """ Config extension for rattail-harvest. """ diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 72936e7..0000000 --- a/setup.cfg +++ /dev/null @@ -1,45 +0,0 @@ -# -*- coding: utf-8; -*- - -[metadata] -name = rattail-harvest -version = attr: rattail_harvest.__version__ -author = Lance Edgar -author_email = lance@edbob.org -url = https://rattailproject.org/ -description = Rattail integration package for Harvest -long_description = file: README.rst -classifiers = - Development Status :: 3 - Alpha - Environment :: Console - Intended Audience :: Developers - 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 - - -[options] -install_requires = - invoke - rattail[db] - -packages = find: -include_package_data = True - - -[options.entry_points] - -rattail.subcommands = - import-harvest = rattail_harvest.commands:ImportHarvest - -rattail.typer_imports = - rattail_harvest = rattail_harvest.commands - -rattail.config.extensions = - rattail_harvest = rattail_harvest.config:RattailHarvestExtension - -rattail.importing = - to_rattail.from_harvest.import = rattail_harvest.importing.harvest:FromHarvestToRattail diff --git a/setup.py b/setup.py deleted file mode 100644 index 71a5a0a..0000000 --- a/setup.py +++ /dev/null @@ -1,29 +0,0 @@ -# -*- coding: utf-8; -*- -################################################################################ -# -# Rattail -- Retail Software Framework -# Copyright © 2010-2023 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 . -# -################################################################################ -""" -rattail-harvest setup script -""" - -from setuptools import setup - -setup() diff --git a/tasks.py b/tasks.py index 6454e3f..3ed6102 100644 --- a/tasks.py +++ b/tasks.py @@ -2,7 +2,7 @@ ################################################################################ # # Rattail -- Retail Software Framework -# Copyright © 2010-2022 Lance Edgar +# Copyright © 2010-2024 Lance Edgar # # This file is part of Rattail. # @@ -25,24 +25,36 @@ Tasks for rattail-harvest """ import os +import re import shutil from invoke import task here = os.path.abspath(os.path.dirname(__file__)) -exec(open(os.path.join(here, 'rattail_harvest', '_version.py')).read()) +__version__ = None +pattern = re.compile(r'^version = "(\d+\.\d+\.\d+)"$') +with open(os.path.join(here, 'pyproject.toml'), 'rt') as f: + for line in f: + line = line.rstrip('\n') + match = pattern.match(line) + if match: + __version__ = match.group(1) + break +if not __version__: + raise RuntimeError("could not parse version!") @task -def release(ctx): +def release(c): """ Release a new version of rattail-harvest """ # rebuild local tar.gz file for distribution - shutil.rmtree('rattail_harvest.egg-info') - ctx.run('python setup.py sdist --formats=gztar') + if os.path.exists('rattail_harvest.egg-info'): + shutil.rmtree('rattail_harvest.egg-info') + c.run('python -m build --sdist') # upload to public PyPI - filename = 'rattail-harvest-{}.tar.gz'.format(__version__) - ctx.run('twine upload dist/{}'.format(filename)) + filename = f'rattail_harvest-{__version__}.tar.gz' + c.run(f'twine upload dist/{filename}')