PyPi packaging

Author: webdev778

.gitignore

@@ -1,2 +1,5 @@
 src/interscript/maps/*.py
 __pycache__
+build/
+dist/
+*.egg-info

README.adoc

@@ -35,6 +35,38 @@ interscript.load_map('bgnpcgn-ukr-Cyrl-Latn-2019')
 print(interscript.transliterate('bgnpcgn-ukr-Cyrl-Latn-2019', input()))
 -----
 
+== Development
+
+Ensure you have used a bootstrap repository https://github.com/interscript/interscript
+and not just cloned this repo yourself, otherwise `./setup.sh` script won\'t work.
+
+`./setup.sh` script is used to build the maps from the `maps` repository using our Ruby
+Interscript implementation. Those maps are compiled to respective `.py` files inside
+`src/interscript/maps/` directory and are not included in this repository.
+
+=== Running tests
+
+[source,shell]
+---
+$ ./setup.sh
+$ pip install -e .
+$ pytest
+---
+
+=== Building package
+
+[source,shell]
+---
+$ ./setup.sh
+$ python -m build
+---
+
+=== Publishing package
+
+[source,shell]
+---
+$ twine publish file.whl
+---
 
 == Copyright and license
 

build.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+rm -rf src/interscript/maps
+mkdir -p src/interscript/maps
+pushd ../ruby
+bundle install || exit 1
+bundle exec rake compile[python,../python/src/interscript/maps] || exit 1
+popd

pyproject.toml

@@ -5,7 +5,7 @@ authors = [
   { name="Ribose Inc.", email="open.source@ribose.com" },
 ]
 description = "Interoperable script conversion systems"
-readme = "README.adoc"
+readme = {file = "README.adoc", content-type = "text/plain"}
 requires-python = ">=3.8"
 classifiers = [
     "Programming Language :: Python :: 3",
@@ -23,5 +23,5 @@ Homepage = "https://www.interscript.org"
 Issues = "https://github.com/interscript/interscript-python/issues"
 
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
+requires = ["setuptools", "wheel", "regex"]
+build-backend = "setuptools.build_meta"

setup.py

@@ -0,0 +1,20 @@
+from setuptools import setup, find_packages
+from setuptools.command.build_py import build_py as _build_py
+import os
+
+class CustomBuildCommand(_build_py):
+    """Ensure the maps are built"""
+
+    def run(self):
+        if not os.path.exists("src/interscript/maps"):
+            print("Maps have not been built. Please issue ./build.sh before trying to build a package.")
+            exit(1)
+
+        # Call the superclass method to perform the standard build
+        super().run()
+
+setup(
+    cmdclass={
+        'build_py': CustomBuildCommand,
+    },
+)