pre_commit run all

Author: isidroas

.github/workflows/github-actions-test.yaml

@@ -6,30 +6,30 @@ jobs:
         steps:
             - name: Check out repository code
               uses: actions/checkout@v2
-              with: 
+              with:
                 python-version: '3.x'
                 #            - name: List files in the repository
                 #              run: |
-                #                ls 
+                #                ls
                 #                pwd
             - name: Install dependencies
               run: |
                   python -m pip install --upgrade setuptools wheel
                   sudo apt install wkhtmltopdf
-            - name: Install package 
+            - name: Install package
               run: python -m pip install  ./
-            - name: Run test 
+            - name: Run test
               run: python ./tests/test_cli.py
-            - name: Run coverage 
-              run: | 
+            - name: Run coverage
+              run: |
                    python -m pip install --upgrade coverage
                    python -m coverage run --source=code_to_pdf -m code_to_pdf ./
                    python -m coverage xml -i
             - uses: codecov/codecov-action@v1
               with:
                 token: c70aa5e5-5e97-45e5-8c04-5fe781a1f5e0
                 files: ./coverage.xml
-            - name: Run Pylint 
-              run: | 
-                   python -m pip install pylint 
+            - name: Run Pylint
+              run: |
+                   python -m pip install pylint
                    python -m pylint --exit-zero code_to_pdf

LICENSE

@@ -19,4 +19,3 @@ 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

@@ -4,7 +4,6 @@
 
 # PDF code proyect generator
 
-Passing a lot of hours in front of a screen is tired. Sometimes we need to analyze libraries that used in our application and in order to give a rest to our eyes this program could be usefull. Its imput is a folder that contain files of code, generating pdf pages of highlighted source. Also, at the beginning an index is added. To known the name of every file a header is added in all of them   
+Passing a lot of hours in front of a screen is tired. Sometimes we need to analyze libraries that used in our application and in order to give a rest to our eyes this program could be usefull. Its imput is a folder that contain files of code, generating pdf pages of highlighted source. Also, at the beginning an index is added. To known the name of every file a header is added in all of them
 
 ![Image conversion](./docs/conversion.svg)
-

pseudo.py

@@ -4,7 +4,8 @@ def add_html(self, html, relative_path):
 
     def get_pages(self):
         return 0
-    
+
+
 class TOC:
     def add_entry(self, relative_path, n_page):
         pass
@@ -14,12 +15,10 @@ def code_to_html(file):
     return ""
 
 
-
-
 def main(path_to_code, output_pdf):
     pdf_creator = PDFCreator()
     toc = TOC()
-    
+
     for file, relative_path in os.walk(path_to_code):
 
         html = code_to_html(file)
@@ -30,4 +29,3 @@ def main(path_to_code, output_pdf):
 
     # toc + pdf_creator => output_pdf
     join_PDFs(pdf_creator.full_output, toc.render_page(), output_pdf)
-

setup.py

@@ -4,17 +4,15 @@
     long_description = fh.read()
 
 setuptools.setup(
-    name="code_to_pdf", # Replace with your own username
+    name="code_to_pdf",  # Replace with your own username
     version="0.0.2",
     author="Isidro Arias",
     author_email="[email protected]",
     description="This convert a software proyect to a pdf book",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/isidroas/code_to_pdf",
-    project_urls={
-        "Bug Tracker": "https://github.com/isidroas/code_to_pdf/issues",
-    },
+    project_urls={"Bug Tracker": "https://github.com/isidroas/code_to_pdf/issues"},
     classifiers=[
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: MIT License",
@@ -23,14 +21,7 @@
     package_dir={"": "src"},
     packages=setuptools.find_packages(where="src"),
     python_requires=">=3.6",
-    install_requires=[
-        'pygments',
-        'pdfkit',
-        'PyPDF2', 
-        'reportlab',
-        'jinja2',
-        'art',
-    ],
-    entry_points = {'console_scripts':['code_to_pdf=code_to_pdf.__main__:main']},
-    include_package_data= True
+    install_requires=["pygments", "pdfkit", "PyPDF2", "reportlab", "jinja2", "art"],
+    entry_points={"console_scripts": ["code_to_pdf=code_to_pdf.__main__:main"]},
+    include_package_data=True,
 )

src/code_to_pdf/html_generator.py

@@ -22,21 +22,28 @@ def code_to_html(input_code: str):
     license_match = re.search(REGEX_PATTERN, file_str)
 
     new_header = REGEX_SUB.format(input_code)
-#    sub_str = new_header + sub_str
+    #    sub_str = new_header + sub_str
     starting_line = 1
 
     if license_match:
         if license_match.start() == 0:
-            starting_line = len(re.findall('\n', license_match[0]))
-            file_str = re.sub(REGEX_PATTERN,'', file_str)
+            starting_line = len(re.findall("\n", license_match[0]))
+            file_str = re.sub(REGEX_PATTERN, "", file_str)
 
     formater = HtmlFormatter(
-        full=True, style="colorful", linenos=True, wrapcode=True, linesparator=True, linenostart=starting_line
+        full=True,
+        style="colorful",
+        linenos=True,
+        wrapcode=True,
+        linesparator=True,
+        linenostart=starting_line,
     )
     try:
         lexer = get_lexer_for_filename(input_code)
     except pygments.util.ClassNotFound:
-        logging.warning('Unable to guess lexer for file {}, using python'.format(input_code) )
+        logging.warning(
+            "Unable to guess lexer for file {}, using python".format(input_code)
+        )
         lexer = get_lexer_by_name("python")
     output_str = highlight(file_str, lexer, formater)
 

src/code_to_pdf/pdf_generator.py

@@ -20,16 +20,13 @@
 }
 
 
-
-
 class PDFCreator:
     def __init__(self):
-        self.page_number=1
-        self.full_pdf = tempfile.NamedTemporaryFile(suffix='.pdf', delete=False).name
+        self.page_number = 1
+        self.full_pdf = tempfile.NamedTemporaryFile(suffix=".pdf", delete=False).name
         print(self.full_pdf)
 
-    
-    def add_html(self, input_html: str,  header_name: str):
+    def add_html(self, input_html: str, header_name: str):
         """Generate numerized pdf pages from a html file
 
         :param input_html: html in string
@@ -41,8 +38,7 @@ def add_html(self, input_html: str,  header_name: str):
         pdf_reader = PyPDF2.PdfFileReader(input_pdf)
         pdf_writer = PyPDF2.PdfFileWriter()
 
-        
-        if os.path.isfile(self.full_pdf) and os.path.getsize(self.full_pdf)>0:
+        if os.path.isfile(self.full_pdf) and os.path.getsize(self.full_pdf) > 0:
             # It is a non empty file
 
             pdf_reader_full = PyPDF2.PdfFileReader(self.full_pdf)
@@ -54,23 +50,23 @@ def add_html(self, input_html: str,  header_name: str):
             page = pdf_reader.getPage(n_page)
 
             ## Create
-            temp_file =  tempfile.NamedTemporaryFile(suffix="pdf", delete=False)
+            temp_file = tempfile.NamedTemporaryFile(suffix="pdf", delete=False)
             c = canvas.Canvas(temp_file.name)
             width, height = A4
             y = height * 0.03
             self.page_number += n_page
             x = width * 0.92
             c.drawString(x, y, str(self.page_number))
 
-            if n_page==0:
+            if n_page == 0:
                 # Print file header for the first page
                 # TODO: add this header in html. This is not mantenible because
                 # the positions depends on the margins
-                textobject = c.beginText(width*0.075, height*0.97)
+                textobject = c.beginText(width * 0.075, height * 0.97)
                 textobject.setFillGray(0.8)
                 c.setFont("Helvetica", 10)
                 textobject.textLine("#")
-                textobject.textLine('# ' + header_name)
+                textobject.textLine("# " + header_name)
                 textobject.textLine("#")
                 c.drawText(textobject)
 
@@ -84,21 +80,12 @@ def add_html(self, input_html: str,  header_name: str):
 
             pdf_writer.addPage(page)
 
-            self.page_number +=1
-
-
+            self.page_number += 1
 
-        with open(self.full_pdf, 'wb') as file:
+        with open(self.full_pdf, "wb") as file:
             pdf_writer.write(file)
 
-
-
-
-
-
-
-
-    def save_in_path(self, path:str):
+    def save_in_path(self, path: str):
         shutil.copyfile(self.full_pdf, path)
 
     @staticmethod
@@ -119,7 +106,6 @@ def merge_pdfs(pdf_list, output_pdf):
         with open(output_pdf, "wb") as file:
             pdf_writer.write(file)
 
-
     @staticmethod
     def add_blank_page(pdf_file):
         pdf_reader = PyPDF2.PdfFileReader(pdf_file)
@@ -132,15 +118,14 @@ def add_blank_page(pdf_file):
         with open(pdf_file, "wb") as file:
             pdf_writer.write(file)
 
-
     @staticmethod
     def number_of_pages(pdf_file):
         """ Get number of pages of a PDF """
         pdf_reader = PyPDF2.PdfFileReader(pdf_file)
         return pdf_reader.getNumPages()
 
 
-if __name__=="__main__":
+if __name__ == "__main__":
     pdfcreator = PDFCreator()
     html_1 = """
 <html>
@@ -163,7 +148,7 @@ def number_of_pages(pdf_file):
 </body>
 </html>
 """
-    pdfcreator.add_html(html_1, 'HTML 1')
-    pdfcreator.add_html(html_2, 'HTML 2')
-    pdfcreator.add_html(html_3, 'HTML 3')
-    pdfcreator.save_in_path('./pruebapdf.pdf')
+    pdfcreator.add_html(html_1, "HTML 1")
+    pdfcreator.add_html(html_2, "HTML 2")
+    pdfcreator.add_html(html_3, "HTML 3")
+    pdfcreator.save_in_path("./pruebapdf.pdf")

src/code_to_pdf/temporal.py

@@ -9,15 +9,15 @@ def __init__(self):
             self.temp_folder = file
         os.mkdir(self.temp_folder)
         logging.info(f"Temporal files will be written in {self.temp_folder}")
-    
+
         self.sub_temp_folder = os.path.join(self.temp_folder, "tmp")
         os.mkdir(self.sub_temp_folder)
-    
-    
+
     def get_temp_folder(self):
         return self.temp_folder
-    
-    
+
     def get_temp_file(self, suffix=".pdf"):
-        with tempfile.NamedTemporaryFile(suffix=suffix, dir=self.sub_temp_folder) as file:
+        with tempfile.NamedTemporaryFile(
+            suffix=suffix, dir=self.sub_temp_folder
+        ) as file:
             return file.name

test_git.py

@@ -1,16 +1,17 @@
 from git import Repo
 import os
 
-PATH = '/home/isidro/wat'
+PATH = "/home/isidro/wat"
 
 
 def get_git_info(path):
     repo = Repo(path)
     is_dirty = repo.is_dirty()
-    commit =  str(repo.head.commit) + '*' if is_dirty else ''
+    commit = str(repo.head.commit) + "*" if is_dirty else ""
     datetime = repo.head.commit.committed_datetime.strftime("%Y-%m-%d %H:%M:%S")
     branch = repo.active_branch.name
     return commit, datetime, branch
 
+
 print(get_git_info(PATH))
-#repo = Repo()
+# repo = Repo()

tests/test_cli.py

@@ -1,6 +1,6 @@
 import os
 from code_to_pdf.run import main
 
-main(['../'])
+main(["../"])
 
-#os.system("code_to_pdf ../")
+# os.system("code_to_pdf ../")