https://github.com/zarethrex/notetex
https://github.com/zarethrex/notetex
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/zarethrex/notetex
- Owner: zarethrex
- License: mit
- Created: 2016-10-18T21:41:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-04T14:17:42.000Z (over 9 years ago)
- Last Synced: 2025-09-20T19:39:03.714Z (9 months ago)
- Language: Python
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# noteTeX
Wouldn't it be great to put all your PDFs into a single directory and then quickly make a report out of them for easy presentation? Well now you can with noteTeX! Create a directory and move all your PDF files to this directory before either calling an instance of `noteTeX`:
```
noteTeX(directory="./",outputfilename="Analysis_Update.tex",captions=[],filestoignoreList=[],keepBuildFiles=False)
```
or simply running within the folder:
```
python /address/to/noteTeX/noteTeX.py
```
## Setting Captions
By default noteTeX simply takes the filename to be the caption for the attached PDF, however the user can specify captions as an argument. The ID for each element at definition is an integer starting from 0 assigned to each file when the files are ordered alphabetically. You can view the elements as a table after running the script by:
```
report = noteTeX()
report.printElements()
```
## TeX Files
noteTeX can import existing LaTeX files, however note that these should not have any preamble, i.e. no`\begin{document}`, `\end{document}` or `usepackage{}` statements etc as they are imported using the `\import{file}` command.
## Prerequisites
For noteTeX to work you require `latexmk` to be installed on your machine. `tabulate` is used to produce the table of elements contained, these are printed using the `printElements()` function.