py package

Author: mr-mixas

.github/workflows/tests.yml

@@ -15,8 +15,6 @@ jobs:
         include:
         - os: macos-latest
           python-version: '3.x'
-        - os: windows-latest
-          python-version: '3.x'
     steps:
     - uses: actions/checkout@v4
 
@@ -25,10 +23,10 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Install dependencies
+    - name: Install package
       run: |
         pip install --quiet --upgrade pip
-        pip install pip install -r requirements.txt -r requirements-dev.txt
+        pip install .[test]
 
     - name: Run tests
       run: |

Dockerfile

@@ -1,19 +1,13 @@
-FROM python:3.10-alpine
+FROM python:3.12-alpine
 
 ARG workdir=/app
-
-ADD static ${workdir}/static
-ADD templates ${workdir}/templates
-COPY api.py requirements.txt run.sh ${workdir}/
-
 WORKDIR ${workdir}
 
 ENV VIRTUAL_ENV=${workdir}/venv
 RUN python -m venv ${VIRTUAL_ENV}
 ENV PATH=${VIRTUAL_ENV}/bin:${PATH}
 
 RUN pip install --upgrade pip
-RUN pip install -r requirements.txt
+RUN pip install nested_diff_restful
 
-ENTRYPOINT ["/bin/sh"]
-CMD ["run.sh"]
+ENTRYPOINT ["nested_diff_restful"]

README.md

@@ -4,11 +4,20 @@ REST API and web UI for [Nested-Diff.py](https://github.com/mr-mixas/Nested-Diff
 
 **[Live Demo](https://nesteddiff.pythonanywhere.com/)**
 
-## Install and run
+## Install
+```sh
+pip install nested_diff_restful
+```
 
+## Run
+```sh
+nested_diff_restful --bind 127.0.0.1:8080 --workers=4
 ```
-pip install -r requirements.txt
-./run.sh
+
+## Run tests
+```sh
+pip install -e .[test]
+pytest
 ```
 
 ## License

nested_diff_restful/__init__.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2024 Michael Samoglyadov
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""REST API and web UI for nested-diff"""
+
+__version__ = '1.0.0'
+__author__ = 'Michael Samoglyadov'
+__license__ = 'Apache License, Version 2.0'
+__website__ = 'https://github.com/mr-mixas/Nested-Diff-RESTful'
+
+
+def start_wsgi_server():
+    import gunicorn.app.base
+    import nested_diff_restful.api
+
+    class WSGIServer(gunicorn.app.base.Application):
+        def init(self, parser, opts, args):
+            pass  # pragma nocover
+
+        def load(self):
+            return nested_diff_restful.api.app  # pragma nocover
+
+    WSGIServer().run()

api.py renamed to nested_diff_restful/api.py

@@ -151,7 +151,7 @@ def nested_diff_script():
     return resp
 
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: nocover
     app.run(
         host=os.environ.get('NESTED_DIFF_REST_HOST', 'localhost'),
         port=os.environ.get('NESTED_DIFF_REST_PORT', 8080),

static/favicon.svg renamed to nested_diff_restful/static/favicon.svg

@@ -1,5 +1,51 @@
+[build-system]
+requires = ['flit_core >=3.2,<4']
+build-backend = 'flit_core.buildapi'
+
+[project]
+name = 'nested_diff_restful'
+authors = [{name = 'Michael Samoglyadov', email = 'mixas.sr@gmail.com'}]
+readme = 'README.md'
+license = {file = 'LICENSE'}
+keywords = ['api', 'diff', 'nested-diff', 'recursive-diff', 'rest']
+classifiers = [
+    'Development Status :: 4 - Beta',
+    'Intended Audience :: Developers',
+    'Intended Audience :: Information Technology',
+    'Intended Audience :: System Administrators',
+    'License :: OSI Approved :: Apache Software License',
+    'Operating System :: OS Independent',
+]
+dynamic = ['version', 'description']
+dependencies = [
+    'flask',
+    'gunicorn',
+    'nested_diff>=1.3.2',
+]
+requires-python = '>=3.8'
+scripts = { nested_diff_restful = 'nested_diff_restful:start_wsgi_server' }
+
+[project.optional-dependencies]
+test = [
+    'pytest',
+    'pytest-cov',
+    'pytest-ruff',
+]
+
+[project.urls]
+Homepage = 'https://github.com/mr-mixas/Nested-Diff-RESTful'
+Repository = 'https://github.com/mr-mixas/Nested-Diff-RESTful.git'
+
 [tool.pytest.ini_options]
-addopts = '-vv --cov=api --cov-fail-under=96 --no-cov-on-fail --ruff --ruff-format'
+addopts = """
+          --cov=nested_diff_restful \
+          --cov-fail-under=97 \
+          --cov-report term-missing \
+          --no-cov-on-fail \
+          --ruff \
+          --ruff-format \
+          --verbosity=2 \
+          """
 
 [tool.ruff]
 line-length = 79