small fixes to LOCCounter. Added files needed to make this a package …

…on pypi

LICENSE.txt

@@ -0,0 +1,17 @@
+MIT License
+Copyright (c) 2018 YOUR NAME
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

README.md

@@ -0,0 +1,23 @@
+# python-loc-counter
+
+This python-loc-counter module was built to count various LOC metrics:
+- source_loc
+- single_comment_loc
+- single_docstring_loc
+- double_docstring_loc
+- total_comments_loc
+- blank_loc
+- total_line_count
+
+### Installation
+This package only uses the standard libaries. Pip install instuctions coming...
+
+```sh
+$ cd test
+```
+
+### Development
+See a feature or found a bug? Feel free to make suggestions or (better yet) contributions for future iterations!
+
+### Example Projects
+- Originally this module was built for: https://github.com/bcdasilv/code-style-mining/tree/python_analysis.

LOCCounter.py → python_loc_counter/LOCCounter.py

@@ -23,7 +23,7 @@ class LOCCounter:
 
 	def __init__(self, file):
 		self.file = file
-		__calcLOC()
+		self.__calcLOC()
 
 	__source_loc = 0
 	__single_comment_loc = 0 
@@ -51,8 +51,8 @@ def getLOC(self):
 			}
 		"""
 
-		return {"source_loc": self.__source_loc, "single_comments_loc": self.__single_comments_loc,
-		"single_docstring_loc": single_docstring_loc, "double_docstring_loc": self.__double_docstring_loc,
+		return {"source_loc": self.__source_loc, "single_comments_loc": self.__single_comment_loc,
+		"single_docstring_loc": self.__single_docstring_loc, "double_docstring_loc": self.__double_docstring_loc,
 		"total_comments_loc": self.__total_comments_loc, "blank_loc": self.__blank_loc,
 		"total_line_count": self.__total_line_count}
 
@@ -80,7 +80,7 @@ def __calcLOC(self):
 					continue
 
 				#Remove quotes for some comment analysis
-				l = re.sub(r"(\"\"\")|(''')|((\"|').*?\4)", __choseRegexGroups, line)
+				l = re.sub(r"(\"\"\")|(''')|((\"|').*?\4)", self.__choseRegexGroups, line)
 				#print(repr(l))
 
 				inDoubleDoc = inDoubleDoc if (l.count('"""')%2 == 0) else not inDoubleDoc

python_loc_counter/__init__.py

@@ -0,0 +1 @@
+from python_loc_counter.LOCCounter import LOCCounter

setup.cfg

@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md

setup.py

@@ -0,0 +1,21 @@
+from distutils.core import setup
+setup(
+  name = 'python_loc_counter',
+  packages = ['python_loc_counter'],
+  version = '0.1',
+  license='MIT', 
+  description = 'Get LOC metrics for python scripts',
+  author = 'Bryce Vonilten',
+  author_email = '[email protected]',
+  url = 'https://github.com/BryceV/python_loc_counter', 
+  download_url = '',
+  keywords = ['python', 'lines of code', 'loc'],
+  install_requires=[ ],
+  classifiers=[
+    'Development Status :: 3 - Alpha', # Chose either "3 - Alpha", "4 - Beta" or "5 - Production/Stable" as the current state of your package
+    'Intended Audience :: Developers',
+    'Topic :: Software Development :: Build Tools',
+    'License :: OSI Approved :: MIT License',
+    'Programming Language :: Python :: 3.7',
+  ],
+)

tests/test.py

@@ -0,0 +1,16 @@
+from python_loc_counter import LOCCounter
+
+def main():
+	file = "./tests/randomFile.txt"
+	counter = LOCCounter(file)
+
+	print(counter.getLOC())
+	print(counter.getSourceLOC())
+	print(counter.getSingleCommentsLOC())
+	print(counter.getSingleDocstringLOC())
+	print(counter.getDoubleDocstringLOC())
+	print(counter.getTotalCommentsLOC())
+	print(counter.getBlankLinesLOC())
+	print(counter.getTotalLineCountLOC())
+
+main()