Let your code take comprehensive notes and publish notes and figures as a beautiful consolidated PDF document.
Project description
Magazine
Let your code take comprehensive notes and publish notes and figures as a beautiful consolidated PDF document.
Idea
The magazine package helps you to create beautiful PDF reports of what has been done during the execution of your app.
- Your scripts or submodules can write Stories in plain human-readable text, which could also include numerical results or figures, for instance.
- The collection of stories can be used to Publish a glossy PDF document.
Example
from magazine import Story, Publish
E = 42
Story.report("Experiment", "The analysis found that energy equals {} Joule.", E)
with Publish("Report.pdf", "My physics report", info="Version 0.1") as M:
M.add_story("Experiment")
- View the resulting magazine in output/Report.pdf.
- Check also
example.py
for more examples.
Install
pip install magazine
Requires:
- fpdf2
- neatlogger (wrapper for loguru)
Acknowledgements
- Uses the Google font Roboto as it just looks great in PDFs.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
magazine-0.2.0.tar.gz
(287.7 kB
view details)
Built Distribution
magazine-0.2.0-py3-none-any.whl
(289.5 kB
view details)
File details
Details for the file magazine-0.2.0.tar.gz
.
File metadata
- Download URL: magazine-0.2.0.tar.gz
- Upload date:
- Size: 287.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.10.11 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7820e03ee46641b490202b88127663c64815c14e39aa13f5412c91252f29e6f1 |
|
MD5 | 88b3c406c01eef49a2f456e48b250472 |
|
BLAKE2b-256 | 363d44e4ef83151662b3a8d5c9be26ada3bd4c2cf02cf5dfe81fb567c8b283df |
Provenance
File details
Details for the file magazine-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: magazine-0.2.0-py3-none-any.whl
- Upload date:
- Size: 289.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.10.11 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 425ca378f4f67d679d0318011de3f66a057267fdece4a8f7781f304ecbb7726e |
|
MD5 | a615584e5d71ebbda2b05636e7faba3b |
|
BLAKE2b-256 | 0c9ab21794f3daf5a789c6603b78796d24de34b3ca7de846fda5c62cd7abf288 |