Commit 026ea640 authored by Mara Karagianni's avatar Mara Karagianni
Browse files

Update zinemaker.pdf, shuffle code, inputs-outputs

parent 66af9a65
......@@ -127,7 +127,7 @@ from the terminal run:
`pdfunite covers/cover.pdf body/body.pdf colophons/colophon.pdf zines/final.pdf`
You shall substitute the file paths to the your own corresponding /path/filenames
You shall substitute the file paths to your own corresponding /path/filenames
## See this readme as the generated screen version zine:
open the file zines/zinemaker.pdf
......@@ -140,7 +140,7 @@ open the file zines/zinemaker.pdf
Default parameters: as input "zines/zinemaker_screen.pdf" and as output "zinemaker{random_number}.pdf"
Run it for your own pdf files as following:
`python shuffle_pdf.py` zines/<input>.pdf zines/<output>.pdf`
`python shuffle_pdf.py` <input_file>.pdf <output_file>.pdf`
In the printer settings opt-in for the following settings:
- A4 Landscape
......
No preview for this file type
......@@ -3,30 +3,28 @@ import random
from zine_maker import Zine
def make_colophon():
# Variables
text_font_size = 12
def make_colophon(inputfile, output):
# set font for all text
zine = Zine(orientation="P", unit="mm", format="A5")
# cover font
# you can change the font to text_font 1 or 2
# or add your fonts
# colophon font
zine.add_font(
'CasaleNBP', '', r"fonts/CasaletwoNbp-Bp4V.ttf", uni=True)
cover_font = 'CasaleNBP'
'CasaleNBP', '', r"./fonts/CasaletwoNbp-Bp4V.ttf", uni=True)
text_font1 = 'CasaleNBP'
# text font
# colophon font alternate
zine.add_font(
'Kpalter', '',
r"fonts/KpProgrammerAlternatesNbp-Zg1q.ttf", uni=True)
text_font = 'Kpalter'
zine.set_font(text_font, '', size=text_font_size)
# text_font2 = 'Kpalter'
# you can change the font to text_font
# or add your fonts
zine.colophon(inputfile, cover_font)
zine.colophon(inputfile, text_font1)
zine.output(output)
print("PDF saved as {}".format(output))
if __name__ == '__main__':
......@@ -36,7 +34,7 @@ if __name__ == '__main__':
output = sys.argv[2]
inputfile = sys.argv[1]
else:
inputfile = "./text/colophon.txt"
output = "./colophones/colophon{}.pdf".format(random.randint(1, 40))
inputfile = "./text/colophon_readme.txt"
output = "./colophons/colophon_readme.pdf".format(random.randint(1, 40))
make_colophon()
make_colophon(inputfile, output)
import sys
import random
from zine_maker import Zine
def make_cover():
# Variables
text_font_size = 12
def make_cover(finput, foutput):
# set font for all text
zine = Zine(orientation="P", unit="mm", format="A5")
# cover font
zine.add_font('CasaleNBP', '', r"fonts/CasaletwoNbp-Bp4V.ttf", uni=True)
zine.add_font('CasaleNBP', '', r"./fonts/CasaletwoNbp-Bp4V.ttf", uni=True)
cover_font = 'CasaleNBP'
# text font
zine.add_font(
'Kpalter', '', r"fonts/KpProgrammerAlternatesNbp-Zg1q.ttf", uni=True)
text_font = 'Kpalter'
zine.set_font(text_font, '', size=text_font_size)
zine.cover(inputfile, cover_font, max_height=140)
zine.output(output)
zine.cover(finput, cover_font, max_height=140)
zine.output(foutput)
print("PDF saved as {}".format(foutput))
if __name__ == '__main__':
......@@ -31,7 +22,7 @@ if __name__ == '__main__':
output = sys.argv[2]
inputfile = sys.argv[1]
else:
inputfile = "./text/cover.txt"
output = "./covers/cover{}.pdf".format(random.randint(1, 40))
inputfile = "./text/cover_readme.txt"
output = "./covers/cover_readme.pdf"
make_cover()
make_cover(inputfile, output)
import sys
import random
from zine_maker import Zine
def make():
def make(inputfile, output):
# Variables
header_font = 'helvetica'
header_font_size = 14
text_font_size = 11
text_font_size = 10
top_margin = 20
left_margin = 20
......@@ -15,27 +12,22 @@ def make():
left_max_margin = 160
max_height = 190
left_x = 20
top_y = 30
cell_width = 110
cell_header_height = 16
cell_height = 6
cell_header_height = 26
cell_height = 8
# set font for all text
zine = Zine(orientation="P", unit="mm", format="A5")
# cover font
zine.add_font(
'CasaleNBP', '', r"fonts/CasaletwoAlternatesNbp-RgRM.ttf", uni=True
)
cover_font = 'CasaleNBP'
# text font
zine.add_font(
'Kpalter', '',
r"fonts/KpProgrammerAlternatesNbp-Zg1q.ttf", uni=True
)
text_font = 'Kpalter'
zine.add_font('CasaleNBP', '', r"./fonts/CasaletwoNbp-Bp4V.ttf", uni=True)
header_font = 'CasaleNBP'
#header_font = 'Kpalter'
text_font = 'helvetica'
zine.set_font(text_font, '', size=text_font_size)
zine.create_pages(inputfile, max_height, left_margin,
......@@ -44,16 +36,19 @@ def make():
header_font, text_font, text_font_size)
zine.output(output)
print("PDF saved as {}".format(output))
if __name__ == '__main__':
# input text and output pdf
if len(sys.argv) > 1:
if len(sys.argv) == 2:
output = "./body/readme.pdf"
if len(sys.argv) == 3:
output = sys.argv[2]
inputfile = sys.argv[1]
else:
inputfile = "./text/oulipo1.txt"
output = "./body/body{}.pdf".format(random.randint(1, 40))
inputfile = "./text/readme"
output = "./body/readme.pdf"
make()
make(inputfile, output)
......@@ -4,298 +4,39 @@ A script for generating A5 size pdf zines
with a text-file input, under development,
GPL3 Licence, Mara Karagianni May 2021
"""
import glob
import re
import sys
import random
import subprocess
from fpdf import FPDF
# ref https://pyfpdf.readthedocs.io/en/latest/
# Variables
header_font = 'helvetica'
header_font_size = 14
text_font_size = 12
top_margin = 20
left_margin = 20
right_margin = 20
left_max_margin = 160
max_height = 190
left_x = 20
top_y = 30
cell_width = 110
cell_header_height = 16
cell_height = 6
# Image variables
img_x = 20
img_y = 80
img_len = 120
class Zine(FPDF):
def add_new_signature(self, top_margin, left_margin, right_margin):
# create new page/signature
self.add_page()
self.set_margins(left_margin, top_margin, right_margin)
self.set_xy(left_margin, top_margin)
print('NEW SIGNATURE')
def move_to_page_right(self, top_margin, left_max_margin, right_margin):
print('*****')
print("BOTTOM OF LEFT PAGE, height is {}".format(self.get_y()))
print('*****')
self.set_margins(top_margin, left_max_margin, right_margin)
self.set_xy(left_max_margin, top_margin)
def position_img(self, img_filename, img_x, img_y, **kwargs):
img_size = subprocess.run(
["identify", "-format",
"%[fx:w/72] by %[fx:h/72] inches",
"./%s" % img_filename],
stdout=subprocess.PIPE, text=True)
img_height_inches = img_size.stdout.split(' ')[2]
img_width_inches = img_size.stdout.split(' ')[0]
img_height_mm = float(img_height_inches) * float(24.5)
img_width_mm = float(img_width_inches) * float(24.5)
if kwargs:
max_height = kwargs["max_height"]
left_margin = kwargs["left_margin"]
top_margin = kwargs["top_margin"]
if self.get_y() + img_height_mm >= max_height:
self.add_page()
self.set_xy(left_margin, top_margin)
img_y = top_margin
previous_y = self.get_y()
# center image
img_x = (150 - img_width_mm) / 2
self.image(img_filename, img_x, img_y, img_width_mm)
# move y at the bottom of the image
# TODO check if get_y() would do the same job
self.set_xy(self.get_x(), previous_y+img_height_mm)
def shuffle_chapters(self, pdfinput):
subprocess.run(
["pdfseparate", "./%s" % pdfinput, "./%02d_chapter.pdf"],
stdout=subprocess.PIPE, text=True)
pages = glob.glob("./*_chapter.pdf")
pages.sort()
print("CHAPTERS {}".format(pages))
shuffled_list = []
count = 0
while count < (len(pages))/2:
shuffled_list.append(pages[-(count+1)])
shuffled_list.append(pages[count])
count += 1
# reverse
if count != len(pages)/2:
shuffled_list.append(pages[count])
shuffled_list.append(pages[-(count+1)])
count += 1
return shuffled_list
def create_pages(self, filename, max_height, left_margin,
left_max_margin, top_margin, right_margin,
cell_width, cell_height, cell_header_height,
header_font, text_font):
chapter = 0
lines = open(filename).readlines()
print(filename)
# first page
print("FIRST PAGE")
self.set_margins(left_margin, top_margin,
right_margin)
self.set_xy(left_margin, top_margin)
self.add_page()
for line in lines:
if ">>" in line:
self.set_font(text_font, '', size=16)
self.cell(cell_width, cell_height, line,
0, ln=1, align='L')
self.set_font(text_font, '', size=text_font_size)
# check if we have an image
elif line.startswith("<img>"):
img_filename = line.split("<img>")[1]
kwargs = {
"max_height": max_height,
"left_margin": left_margin,
"top_margin": top_margin
}
self.position_img(
img_filename, self.get_x(), self.get_y(), **kwargs)
# check if we have a title
elif line.startswith("<h2>"):
line = re.sub('((<h2>)|(</h2>$))', '', line)
self.set_text_color(255, 0, 255)
self.set_font(text_font, size=22)
if self.get_y() > top_margin:
self.set_xy(left_margin, top_margin+9)
self.add_page()
self.cell(cell_width, cell_header_height, line,
0, ln=1, align='C')
left_x = self.get_x()
top_y = self.get_y()
self.dashed_line(
left_x, top_y, left_x+cell_width, top_y,
dash_length=3, space_length=3)
self.set_text_color(0, 0, 0)
self.set_font(text_font, size=text_font_size)
elif line.startswith("<b>"):
line = re.sub('((<b>)|(</b>$))', '', line)
self.set_font(text_font, '', size=18)
self.cell(cell_width, cell_height, line,
0, ln=1, align='L')
self.set_font(text_font, '', size=text_font_size)
elif line.startswith("#"):
self.set_font('helvetica', 'B', size=9)
self.set_text_color(209, 17, 65)
self.multi_cell(cell_width, cell_height, line,
0, align='L')
# go back to text font
self.set_text_color(0, 0, 0)
self.set_font(text_font, '', size=text_font_size)
elif line.startswith("$") or line.startswith("(venv)"):
self.set_font('helvetica', 'B', size=9)
self.set_text_color(0, 30, 255)
self.multi_cell(cell_width, cell_height, line,
0, align='L')
# go back to text font
self.set_text_color(0, 0, 0)
self.set_font(text_font, '', size=text_font_size)
elif line.startswith("<conf>"):
#line = re.sub('(<conf>$)', '', line)
self.set_font('helvetica', 'B', size=9)
self.set_text_color(0,80,115)
self.multi_cell(cell_width, cell_height, line,
0, align='L')
elif line.startswith("</conf>"):
#line = re.sub('(</conf>$)', '', line)
self.multi_cell(cell_width, cell_height, line,
0, align='L')
self.set_font(text_font, '', text_font_size)
self.set_text_color(0, 0, 0)
elif "<index>" in line:
line = re.sub('(<index>$)', '', line)
self.set_font(text_font, '', size=18)
self.set_text_color(0, 0, 0)
self.set_text_color(41, 98, 255)
self.cell(cell_width/8, cell_height, line, 0, align='C')
elif "</index>" in line:
line = re.sub('(</index>$)', '', line)
self.set_font(text_font, '', size=text_font_size)
self.set_text_color(0, 0, 0)
self.multi_cell(cell_width, cell_height, line,
0, align='L')
else:
# check if we need the following
variable_x = self.get_x()
self.multi_cell(cell_width, cell_height, line, 0, align='L')
self.set_xy(variable_x, self.get_y())
self.footer()
def cover(self, title, cover_font, max_height):
col = 10
margin = 15
import random
self.set_margins(margin, margin, margin)
self.add_page()
for letter in title:
if self.get_y() >= max_height:
self.set_xy(margin+col, margin)
col += 40
size = random.randrange(30, 50, 15)
self.set_font(cover_font, '', size)
variable_x = margin+col
print("LETTER {}, POSITION Y {}".format(letter, self.get_y()))
print("VAR X {}".format(variable_x))
self.set_xy(variable_x, self.get_y())
self.cell(size, size, letter)
self.line(size, size, self.get_x(), self.get_y())
if(size % 2 == 0):
var = "DF"
#r = 138, 43, 226
R = random.randrange(30, 255, 40)
G = random.randrange(0, 55, 55)
B = random.randrange(0, 155, 50)
self.set_fill_color(R, G, 255)
else:
var = "D"
print(var)
self.rect(
float(self.get_x()), float(self.get_y()),
float(size/2), float(size*4), style = var)
self.ln(size/2)
def colophon(self, text):
lines = open(text, 'r').readlines()
top_margin = 20
margin = 25
self.add_font(
'CasaleNBP', '', r"fonts/CasaletwoNbp-Bp4V.ttf",
uni=True)
self.set_margins(margin, top_margin, margin)
size = 13
cover_font = 'CasaleNBP'
self.set_font(cover_font, '', size)
self.add_page()
for line in lines:
self.multi_cell(100, size, line, 0, align='C')
def footer(self):
# Go to 1.5 cm from bottom
self.set_y(-15)
# Select Arial italic 8
#self.set_font('Arial', 'I', 8)
self.set_text_color(0, 0, 0)
self.set_font(text_font, '', size=text_font_size)
# Print current and total page numbers
self.cell(0, 10, '%s' % self.page_no(), 0, 0, 'C')
# file to get the text
if len(sys.argv) > 1:
if len(sys.argv) == 3:
output = sys.argv[2]
filename = sys.argv[1]
else:
filename = "./finals/test.pdf"
output = './finals/trial.pdf'
# set font for all text
zine = Zine(orientation="P", unit="mm", format="A5")
# cover font
zine.add_font('CasaleNBP', '', r"fonts/CasaletwoNbp-Bp4V.ttf", uni=True)
cover_font = 'CasaleNBP'
# text font
zine.add_font(
'Kpalter', '', r"fonts/KpProgrammerAlternatesNbp-Zg1q.ttf", uni=True)
text_font = 'Kpalter'
zine.set_font(text_font, '', size=text_font_size)
import sys
chapter_list = zine.shuffle_chapters(filename)
subprocess.Popen(["pdfunite"] + chapter_list + [output])
from zine_maker import Zine
def shuffle_zine(finput, foutput):
# set font for all text
zine = Zine(orientation="P", unit="mm", format="A5")
chapter_list = zine.shuffle_chapters(finput)
proc = subprocess.Popen(
["pdfunite"] + chapter_list + [foutput],
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE
)
out, err = proc.communicate()
if err:
print("Something went wrong!", err.decode('utf-8'), sep="\n")
else:
print("PDF saved as {}".format(foutput))
os.system("mv ./*_chapter.pdf ./tmp")
if __name__ == '__main__':
# file to get the text
if len(sys.argv) > 1:
if len(sys.argv) == 3:
output = sys.argv[2]
filename = sys.argv[1]
else:
filename = "./zines/zinemaker_screen.pdf"
output = "./zines/zinemaker{}.pdf".format(random.randint(1, 40))
shuffle_zine(filename, output)
## To Download the project, near the top of the page, click on the download icon next to "WEB IDE".
You can choose which type of archived folder you want, and then open it in your filesystem.
# Introduction
This zine helps in navigating the zine_maker code, a small software tool derived from pyPDF library. The code is written in Python, and provides a few scripts for creating covers, colophons, content, and also signatures for preparing a PDF for the printer. The scripts run with python version 3.x.x and we can feed to the scripts inputs and outputs. As an input, we give the path to a text file, which shall create the text and images content of the zine, and as an output we give a the path/filename of our choice. We can also run the scripts with no input nor output, in which case, they take as default parameters the readme text from the text/ folder and produce an output to either of the folders covers, colophons, body, or zines, depending on which script we are running each time.
# Get the code
## Download the source code
As of 2021-2022, the code is under active development by the author and can be cloned and/or downloaded from https://git.systerserver.net/mara/zine_maker.
To download the project, near the top of the gitlab page, click on the download icon next to "Find file".
You can choose which type of archived folder you want, and then open it in your filesystem, by right clicking the archived folder, or from the terminal:
```
tar -xvf zine_maker.tar -C /home/user/destination
unzip zinme_maker.zip -d /home/user/destination
```
## OR use git clone:
```
......@@ -7,65 +19,130 @@ git clone https://zine:DskM_8XxtKt-Wym1xHd1@git.systerserver.net/mara/zine_maker
cd zine_maker
```
# Requirements
## Requirements
You need either python2 or python3 running on the computer
Basic requirements are listed here.
Python3 should be installed on the computer
https://www.python.org/downloads/
And also the pip command
And also the pip command if it didn't get installed with Python
https://pip.pypa.io/en/stable/installation/
Once these are installed, from within zine_maker run:
Once these are installed, from within zine_maker folder run:
`pip install -r requirements.txt`
## For merging the cover.pdf, body.pdf and colophon.pdf there are many pdf merger tools,
one that is command line based is pdfunite
http://linux-commands-examples.com/pdfunite
# Miscellaneous
from the terminal run:
## Fonts
The source code comes with some fonts under the fonts folder. You can use your
fonts of preference by adding them either in the fonts folder and edit the
files cover.py, colophon.py and doc_pdf.py to give the new names. Or add your
absolute font path directly to the python scripts.
`pdfunite cover.pdf body.pdf colophon.pdf output.pdf`
## Text
The input texts should be clean from characters added by some text editors or
Operating Systems. Use the cat command to check your text is ready as input
with:
`cat --show-nonprinting input.txt`
## For shuffling the final pdf and prepare it for printing you need the pdfseparate command
Symbols such as M-oM-;M or ^M (carriage Return / line feed) need to be removed.
A cool tool for that is dos2unix, which is available as command line, but needs
to be installed:
`dos2unix filename`
Or with the sed command:
`sed -e "s/\r//g" file > newfile`
Extensive info can be find at:
https://www.cyberciti.biz/faq/sed-remove-m-and-line-feeds-under-unix-linux-bsd-appleosx/
## Layout
All the font styling happens in the zine_maker function create_pages(). The
input text is parsed for specific tags or symbols in the begining of each line
and changes to the font color and size happen accordingly. We can add more or edit
existing rules, directly in the zine_maker code.
## Parameters
The python scripts cover.py, colophon.py and doc_pdf.py take a text input and an output filename. If we give no input/output, the default input is the related readme files under covers/body/colophons/
## Merge
For merging the cover, body and colophon pdf files, there are many pdf merger tools. One that is command line based and is used in this tutorial is pdfunite
http://linux-commands-examples.com/pdfunite
## Print
For shuffling the final pdf and prepare it for printing you need the pdfseparate command
http://www.linux-commands-examples.com/pdfseparate
it is used inside the shuffle_pdf.py file (see details at the end of this Readme)
it is used inside the shuffle_pdf.py file (see details at the end of this README).
## For making use of images in the script, image magick needs to be installed
## Images
For making use of images in the script
image magick needs to be installed
http://www.imagemagick.org/
## To make the content of the pdf
# Run the code!