Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build PDF Book #33

Merged
merged 4 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions new-website/utils/tutorials/build_pdf_book.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
"""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GreatRSingh Add a section to the documentation / README on the PDF building capability

This script is used to build the pdf book from DeepChem Tutorials.

Requirements:
- pdfunite
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add this to our requirements.txt

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pdfunite is a linux application which i am using to merge pdfs.
I added pdfkit to requirements.txt.


Example Usage:
- Run the script "fetch_tutorials.py" // It will fetch all the tutorials.
- Run the script "build_pdf_book.py"
- It may cause error, mostly due to the type of graphic used in some tutorials
which donot compile properly, remove them from the website-render-order or fix
them, and run this script again.

NOTE:
- NO FILES OR DIRECTORIES HAVE TO BE CREATED MANUALLY. The script will create the required directories and files.
- Run scripts in the Top-Level folder.

"""
import os
import pandas as pd
import pdfkit
from utils import numeric_sorter


INFO_PATH = "/workspaces/deepchem.github.io/new-website/utils/tutorials/website-render-order/"
DATA_PATH = "/workspaces/deepchem.github.io/new-website/utils/tutorials/html-notebooks/"
PDF_PATH = "/workspaces/deepchem.github.io/new-website/utils/tutorials/storage/"

files = os.listdir(INFO_PATH)
files = sorted(files)

files_list = numeric_sorter(files)

def html_to_pdf():
"""
Converts HTML files to PDF files.

Raises
------
ProtocolUnknownError
If it faces some unknown kind of graphic.

"""
for i in files_list:
chapter = pd.read_csv(INFO_PATH + "-".join(i))
for j in chapter["File Name"]:
print(i, j)
pdfkit.from_file(DATA_PATH + j[:-5] + "html", PDF_PATH + j[:-5] + "pdf")

def merge_pdf():
"""Merges the compiled PDFs."""
command = "pdfunite "
for i in files_list:
chapter = pd.read_csv(INFO_PATH + "-".join(i))
for j in chapter["File Name"]:
print(i, j)
command = command + PDF_PATH + j[:-5] + "pdf "
os.system(command + "merged.pdf")


if __name__ == "__main__":
os.system("mkdir " + PDF_PATH)
html_to_pdf()
merge_pdf()
26 changes: 26 additions & 0 deletions new-website/utils/tutorials/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,32 @@
import re


def numeric_sorter(s):
"""
Sorts the tutorials according to their serial number.

Parameters
----------
s: List[str]
The List to be sorted.

Returns
-------
s_sorted: List[List[str]]
The sorted and Broken into parts list.

"""
s_splitted_list = []
s_sorted = []
for i in s:
s_splitted_list.append(i.split("-"))
for i in range(len(s_splitted_list)+1):
for j in s_splitted_list:
if i == int(j[0]):
s_sorted.append(j)
return s_sorted


def to_valid_identifier(s):
"""
Converts a given string into a valid identifier.
Expand Down