Merge pull request #8 from jftuga/pypi-prep

prepare for PiPY deployment

Author: jftuga

Makefile

@@ -0,0 +1,71 @@
+# Configuration:
+# Only set these if they have not been defined via command-line
+# such as: make VENV_NAME=my_custom_venv
+VENV_NAME ?= venv
+PYTHON ?= python3
+PYPIRC = $(HOME)/.pypirc
+
+# Extract PROJECT_NAME from setup.py using helper script
+PROJECT_NAME := $(shell $(PYTHON) get_project_name.py)
+
+# Default target
+.DEFAULT_GOAL := test-publish
+
+# exclude special targets that start with a dot (like .PHONY)
+# exclude pattern rules that use % (like %.o: %.c)
+show-make-targets:
+	@grep -E '^[^.%].*[^ ]:' Makefile | cut -d: -f1 | grep -i '^[a-z]'
+
+# Show the project name found in setup.py
+show-project-name:
+	@echo $(PROJECT_NAME)
+
+# Check for ~/.pypirc
+check-pypirc:
+	@if [ ! -f $(PYPIRC) ]; then \
+		echo "Error: $(PYPIRC) not found. Please create it with your PyPI credentials."; \
+		exit 1; \
+	fi
+
+# Create and configure virtual environment
+$(VENV_NAME):
+	$(PYTHON) -m venv $(VENV_NAME)
+	./$(VENV_NAME)/bin/pip install --upgrade pip
+	./$(VENV_NAME)/bin/pip install setuptools wheel twine
+
+# Build distribution
+build: $(VENV_NAME)
+	./$(VENV_NAME)/bin/python setup.py sdist bdist_wheel
+
+# Clean build artifacts and virtual environment
+clean:
+	rm -rf build/
+	rm -rf dist/
+	rm -rf *.egg-info/
+	rm -rf $(VENV_NAME)/
+	rm -rf __pycache__/
+	rm -rf test-install-venv/
+	rm -f *.whl.metadata .??*~
+	find . -type d -name "__pycache__" -exec rm -r "{}" +
+	find . -type f -name "*.pyc" -delete
+	command pip cache purge
+
+# Test PyPI targets
+test-publish: clean check-pypirc $(VENV_NAME) build
+	./$(VENV_NAME)/bin/twine upload --verbose --repository testpypi dist/*
+
+test-install: clean
+	$(PYTHON) -m venv test-install-venv
+	./test-install-venv/bin/pip install --force-reinstall --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ $(PROJECT_NAME)
+
+# Production PyPI targets
+prod-publish: clean check-pypirc $(VENV_NAME) build
+	@echo "Are you sure you want to publish to production PyPI? [y/N] " && read ans && [ $${ans:-N} = y ]
+	./$(VENV_NAME)/bin/twine --verbose upload dist/*
+
+prod-install: clean
+	$(PYTHON) -m venv prod-install-venv
+	./prod-install-venv/bin/pip install --force-reinstall $(PROJECT_NAME)
+
+# Declare targets that don't create a file of the same name
+.PHONY: show-make-targets show-project-name check-pypirc build clean test-publish test-install prod-publish prod-install

Pipfile

@@ -9,8 +9,8 @@ ruff = "*"
 
 [packages]
 chardet = ">=5.2.0"
-spacy = ">=3.8.3"
-torch = ">=2.5.1"
+spacy = ">=3.8.3,<4.0.0"
+torch = ">=2.5.1,<3.0.0"
 veryprettytable = {git = "https://github.com/andrewspiers/VeryPrettyTable.git"}
 
 [requires]

Pipfile.lock

@@ -15,13 +15,16 @@ A Python module that removes personally identifiable information (PII) from text
 ## Installation
 
 ```bash
+pip install text-deidentification
+
+# or...
+
 pip install git+https://github.com/jftuga/deidentification.git
 ```
 
 ### Requirements
 
-- Python 3.7 or higher
-- spaCy
+- Python 3.10 or higher
 - spaCy's `en_core_web_trf` model (or another compatible model)
 
 Download the required spaCy model:

README.md

@@ -1,6 +1,6 @@
 pgmName = "deidentification"
 pgmUrl = "https://github.com/jftuga/deidentification"
-pgmVersion = "1.2.0"
+pgmVersion = "1.2.1"
 
 GENDER_PRONOUNS = {
     "he": "HE/SHE",

deidentification/deidentification_constants.py

@@ -85,35 +85,35 @@ def main() -> int:
     parser = argparse.ArgumentParser(
         description="De-identify personally identifiable information in text files"
     )
-    
+
     parser.add_argument(
         "input_file",
         help="text file to deidentify (use '-' for STDIN)",
         metavar="input_file"
     )
-    
+
     parser.add_argument(
         "-r",
         "--replacement",
         default="PERSON",
         help="a word/phrase to replace identified names with (default: PERSON)",
         metavar="REPLACEMENT"
     )
-    
+
     parser.add_argument(
         "-o",
         "--output",
         help="output file (if not specified, prints to STDOUT)",
         metavar="OUTPUT_FILE"
     )
-    
+
     parser.add_argument(
         "-H",
         "--html",
         action="store_true",
         help="output in HTML format"
     )
-    
+
     parser.add_argument(
         "-v",
         "--version",

deidentification/deidentify.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+"""Extract project name from setup.py."""
+
+import ast
+import sys
+from pathlib import Path
+
+def get_project_name(setup_path='setup.py', default='myproject'):
+    """Extract the project name from setup.py using AST parsing."""
+    try:
+        setup_content = Path(setup_path).read_text()
+        module = ast.parse(setup_content, mode='exec')
+
+        # Look for setup() call and find 'name' keyword argument
+        for node in module.body:
+            if (isinstance(node, ast.Expr) and
+                isinstance(node.value, ast.Call) and
+                isinstance(node.value.func, ast.Name) and
+                node.value.func.id == 'setup'):
+
+                for keyword in node.value.keywords:
+                    if keyword.arg == 'name':
+                        if isinstance(keyword.value, ast.Constant):
+                            return keyword.value.value
+                        elif isinstance(keyword.value, ast.Name):
+                            # If name is a variable, try to find its definition
+                            name_id = keyword.value.id
+                            for prior_node in module.body:
+                                if (isinstance(prior_node, ast.Assign) and
+                                    len(prior_node.targets) == 1 and
+                                    isinstance(prior_node.targets[0], ast.Name) and
+                                    prior_node.targets[0].id == name_id and
+                                    isinstance(prior_node.value, ast.Constant)):
+                                    return prior_node.value.value
+
+        return default
+
+    except (FileNotFoundError, SyntaxError, AttributeError):
+        return default
+
+if __name__ == '__main__':
+    print(get_project_name())

get_project_name.py

@@ -1,4 +1,5 @@
 chardet~=5.2.0
 veryprettytable~=0.8.1
-spacy~=3.8.3
-torch~=2.5.1
+spacy~=3.8.3,<4.0.0
+torch~=2.5.1,<3.0.0
+en_core_web_trf @ https://github.com/explosion/spacy-models/releases/download/en_core_web_trf-3.8.0/en_core_web_trf-3.8.0-py3-none-any.whl

requirements.txt

@@ -11,7 +11,7 @@
     long_description = fh.read()
 
 setup(
-    name="deidentification",
+    name="text-deidentification",
     version=pgmVersion,
     author="John Taylor",
     author_email="",
@@ -21,24 +21,24 @@
     url="https://github.com/jftuga/deidentification",
     packages=find_packages(),
     classifiers=[
-        "Development Status :: 4 - Beta",
+        "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",
+        "Intended Audience :: Healthcare Industry",
+        "Intended Audience :: Legal Industry",
         "License :: OSI Approved :: MIT License",
+        "Natural Language :: English",
         "Operating System :: OS Independent",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
         "Topic :: Text Processing",
         "Topic :: Security",
     ],
-    python_requires=">=3.7",
+    python_requires=">=3.10",
     install_requires=[
-        "spacy>=3.0.0",
-        "torch>=2.5.1",
+        "spacy>=3.8.3,<4.0.0",
+        "torch>=2.5.1,<3.0.0",
         "chardet>=5.2.0",
         "veryprettytable>=0.8.1",
     ],