Restructure python modules into pf_focus python package

Update docker container image to allow custom arguments

Author: mback2k

.dockerignore

@@ -0,0 +1,11 @@
+__pycache__
+.coverage
+.vscode
+test.*
+
+.git
+.dockerignore
+Dockerfile
+
+logos
+screenshots

Dockerfile

@@ -1,10 +1,13 @@
-FROM python:3.5
+FROM python:3
 
 RUN mkdir /app
 WORKDIR /app
 
 COPY requirements.txt ./
 RUN pip install -r requirements.txt
 
-COPY *.py ./
-CMD ./format.py -q -f md -i - -o -
+ADD ./ ./
+RUN pip install ./
+
+ENTRYPOINT ["/usr/local/bin/pfFocus-format"]
+CMD ["-q", "-f", "md", "-i", "-", "-o", "-"]

MANIFEST.in

@@ -0,0 +1,5 @@
+include *.py
+include LICENSE
+include README.md
+include requirements.txt
+recursive-include pf_focus *.py

Makefile

@@ -4,7 +4,7 @@ Pipfile.lock: Pipfile
 	pipenv lock --pre
 
 requirements.txt: Pipfile Pipfile.lock
-	pipenv lock --pre --requirements > requirements.txt
+	pipenv lock --pre --requirements | grep -v "^-i" > requirements.txt
 
 tests/requirements.txt: Pipfile Pipfile.lock
 	pipenv lock --pre --dev --requirements > tests/requirements.txt
@@ -14,4 +14,7 @@ test:
 	$(MAKE) -C tests all
 
 lint:
-	pylint --disable=line-too-long,missing-docstring format.py
+	pylint --disable=line-too-long,missing-docstring pf_focus
+
+build: setup.py
+	pipenv run python3 setup.py sdist bdist_wheel

Pipfile.lock

@@ -43,32 +43,32 @@ pfFocus currently supports the following configuration sections:
 
 ## Usage
 
-Main formatting tool: ```format.py```
+Main formatting tool: ```pf-format```
 ```
-format.py
+pf-format
 ```
 
 Examples:
 ```
-./format.py -i config-backup.xml -f md -o test.md
-./format.py -i config-backup.xml -f yaml -o test.yaml
+pf-format -i config-backup.xml -f md -o test.md
+pf-format -i config-backup.xml -f yaml -o test.yaml
 ```
 
-Test parsing tool: ```parse.py```
+Test parsing tool: ```pf-parse```
 ```
-parse.py [-h] input_path
+pf-parse [-h] input_path
 ```
 
 Examples:
 ```
-./parse.py config-backup.xml
+pf-parse config-backup.xml
 ```
 
 ### Usage with Docker
 
 When using pfFocus via Docker, you don't need to download it from Github, and you don't need to install Python or any libraries. Only Docker is required.
 
-It runs this command inside Docker: `./format.py -q -f md -i - -o -`, which means it works with `STDIN` and `STDOUT` instead of files.
+It runs this command inside Docker: `pf-format -q -f md -i - -o -`, which means it works with `STDIN` and `STDOUT` instead of files.
 
 ```bash
 docker run --rm -i hugojosefson/pffocus < input.xml > output.md

README.md

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
-from pfsense import PfSenseNode, PfSenseRuleAlias, PfSenseRuleInterface, PfSenseRuleLocation
-from util import dict_to_list, obj_to_dict, obj_to_list, hasattr_r
+from pf_focus.pfsense import PfSenseNode, PfSenseRuleAlias, PfSenseRuleInterface, PfSenseRuleLocation
+from pf_focus.util import dict_to_list, obj_to_dict, obj_to_list, hasattr_r
 
 
 def size(s, size):

bbcode.py renamed to pf_focus/bbcode.py

@@ -4,11 +4,11 @@
 
 import yaml
 
-from markdown import output_markdown
-from bbcode import output_bbcode
-from parse import parse_pfsense
-from pfsense import PfSenseDocument
-from progress import Animation
+from pf_focus.markdown import output_markdown
+from pf_focus.bbcode import output_bbcode
+from pf_focus.parse import parse_pfsense
+from pf_focus.pfsense import PfSenseDocument
+from pf_focus.progress import Animation
 
 
 def output_yaml(doc, stream):

format.py renamed to pf_focus/format.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
-from pfsense import PfSenseNode, PfSenseRuleAlias, PfSenseRuleInterface, PfSenseRuleLocation
-from util import dict_to_list, obj_to_dict, obj_to_list, hasattr_r
+from pf_focus.pfsense import PfSenseNode, PfSenseRuleAlias, PfSenseRuleInterface, PfSenseRuleLocation
+from pf_focus.util import dict_to_list, obj_to_dict, obj_to_list, hasattr_r
 
 
 def format_rule_interface(rule_interface):

markdown.py renamed to pf_focus/markdown.py

@@ -7,8 +7,8 @@
 
 from defusedxml.sax import parse
 
-from pfsense import PfSenseDocument
-from util import DataList
+from pf_focus.pfsense import PfSenseDocument
+from pf_focus.util import DataList
 
 
 class PfSenseContentHandler(ContentHandler):