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")
Install
pip install magazine
Requires:
- loguru
- fpdf2
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.1.tar.gz
(287.6 kB
view details)
Built Distribution
magazine-0.1-py3-none-any.whl
(289.4 kB
view details)
File details
Details for the file magazine-0.1.tar.gz
.
File metadata
- Download URL: magazine-0.1.tar.gz
- Upload date:
- Size: 287.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.11.9 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42eb5e92e66eef9402a34bac03c86c84109c763cb11cc82f85a4883416d390c3 |
|
MD5 | f16c1f5e72921109c822169e363ceb68 |
|
BLAKE2b-256 | 8dd540ed1f473aa51e14240abe9ff16dce8f486948fd343cff907ad1c544de52 |
Provenance
File details
Details for the file magazine-0.1-py3-none-any.whl
.
File metadata
- Download URL: magazine-0.1-py3-none-any.whl
- Upload date:
- Size: 289.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.11.9 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38515941e3ba5b88a7c2290c7223e34a748b3cbb483e1c9caaa3c95ab01b5bba |
|
MD5 | c73fe7d856247b3c530efd21ed938e76 |
|
BLAKE2b-256 | 335aed5d2b722521bc64c0f434291075e784df0568a07fdf0ba2c2f3fd09d88b |