Add files via upload

Author: JavaScriptDude

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 JavaScriptDude
+Copyright (c) 2022 Timothy C. Quinn <javascriptdude [at] protonmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+include pyproject.toml

README.md

@@ -12,9 +12,10 @@ python3 -m pip install commstrip
 * emacs 28.1+
 * language files for languages that need processing
 
-Note: This code is presently written for Linux and shoudl work out of the box on MacOS and Cygwin. Windows support is planned.
+Note: This code is presently written for Linux and should work out of the box on MacOS and Cygwin but has not been tested there yet. Windows support is planned.
 
-### Create Alias - Add to ~/.bashrc
+### Create Alias
+Add to `~/.bashrc`:
 ```
 function __comstrip {
 	python3 /dpool/vcmain/dev/lisp/comstrip/src/comstrip/comstrip.py "$@"
@@ -24,13 +25,13 @@ alias comstrip='__comstrip'
 
 ### CLI Usage:
 
-#### 3-way meld compare
+#### CLI - 3-way meld compare
 Compare /r1/src1.py to /r2/src2.py and /r2/src3.py, strip comments, blank lines and trailing spaces and launch in meld
 ```
 comstrip --basedir /dpool/vcmain/dev/lisp/comstrip/test/data --noblank --notrail --meld --file /r1/src1.py /r2/src2.py /r3/src3.py
 ```
 
-## Stats only
+#### CLI - Stats only
 Compare /r1/src1.py to /r3/src1.py, strip comments, blank lines and trailing spaces and show stats
 ```
 comstrip --basedir /dpool/vcmain/dev/lisp/comstrip/test/data --noblank --notrail --stats --file /r1/src1.py /r3/src2.py
@@ -47,13 +48,36 @@ Stats: /r1/src1.py <-> /r3/src1.py (/dpool/vcmain/dev/lisp/comstrip/test/data):
 /r3/vtscan.py | /tmp/cs_zz_cs_220420-211346.452998_vtscan_211347429.py | True |    -
 ```
 
+#### CLI - Use Meld to troubleshoot stripping of comments etc.
+Call with --meld option and pass only one file Meld will be launched showing the before and after of comment stripping
+This can be used as you tweak your emacs packages to ensure that the Language processsing is working as expected
+```
+comstrip --meld --noblank --notrail --file /dpool/vcmain/dev/lisp/comstrip/test/data/r3/src1.py
+```
+
 ### Python API Usage:
-See `test/comstrip_test.py` for API examples
+* ComStrip - Main API Object
+* DiffStats - Object containging diff information including stats
+* Diff - Representation of two files and contains a `stats:DiffStats` after processing
+* DiffSet - Collection of Diffs for batch processing
+* CSStat - Contains info about Comment Strip Processing: ok, file_in, file_out, message
+
+Because of overhead of invoking sub-processes, it is best to use API that can process mulitple files in one batch, it is strongly recommended to use `<ComStrip>.process(diffset:DiffSet)` or `<ComStrip>.process(files:list)` to leverage the optimizations in those APIs.
+
+See `test/hand_tests.py` for implementation of the four API call types: `diffset:DiffSet`, `diff:Diff`, `files:list` and `file:str`.
 
 
+### Debug using VSCode after git checkout
+If you want to play around without having to install, just do a git checkout of the repo and add to your `.vscode/settings.json`:
+```
+{
+    "python.envFile": "${workspaceFolder}/dev.env"
+}
+```
+
 ### TODO:
 [.] Make proper installer for system to get comstrip command working without alias
 [.] Port to Windows
 [.] Verify in Cygwin and MacOs
 [.] Build out proper testing
-[.] Implement leading tab handling
+[.] Implement leading tab handling

dev.env

@@ -0,0 +1 @@
+PYTHONPATH=./src:${PYTHONPATH}

examples/example_emacs.sh

@@ -0,0 +1,4 @@
+ELISP="(load \"/dpool/vcmain/dev/lisp/comstrip/comstrip.lisp\")"
+emacs --file=/dpool/vcmain/dev/py/ffr/ffr.py --quick --batch --eval "$ELISP"
+emacs --file=/dpool/vcmain/dev/py/ffrc/ffrc.py --quick --batch --eval "$ELISP"
+emacs --file=/dpool/vcmain/dev/py/qcorelite/qcorelite.py --quick --batch --eval "$ELISP"

pyproject.toml

@@ -0,0 +1,37 @@
+[tool.poetry]
+name = "comstrip"
+version = "0.0.1"
+description = "Universal Code Comment Stripper and Diff Analysis tools leveraging Emacs Language support"
+license = "MIT"
+authors = ["Timothy C. Quinn"]
+readme = "README.md"
+homepage = "https://pypi.org/project/comstrip"
+repository = "https://github.com/JavaScriptDude/comstrip"
+classifiers = [
+    'Development Status :: 4 - Beta',
+    'Environment :: Console',
+    'Intended Audience :: Developers',
+    'Operating System :: POSIX :: Linux',
+    'Operating System :: POSIX :: BSD',
+    'Operating System :: POSIX :: SunOS/Solaris',
+    'Operating System :: MacOS :: MacOS X',
+    'Programming Language :: Python :: 3 :: Only',
+    'Programming Language :: Python :: 3.7',
+    'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Topic :: Software Development',
+]
+
+[tool.poetry.dependencies]
+python = "^3.7.9"
+thefuzz = ">=0.19.0"
+python-Levenshtein = ">=0.12.2"
+texttable = ">=1.6.3"
+tiotrap = ">=0.3"
+
+[tool.poetry.dev-dependencies]
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

requirements.txt

@@ -0,0 +1,4 @@
+thefuzz
+python-Levenshtein
+tiotrap
+texttable

src/comstrip/__init__.py

@@ -0,0 +1,4 @@
+# Main objects
+from .comstrip import ComStrip, DiffSet, Diff, CSStat
+# Helpful utilities
+from .comstrip import util as csutil