Paperead is a tiny tool to present and manage your reading and notes.
- Platform
- Python
Features
- File-system based storage
- Simple and readable
- Easy to use with VSCode
- Notes in markdown
- CommonMark
- LaTex Math
- Media (locally hosted or remote files)
- Code highlighting
- Lists and tables
- Graphs
- Rich pages
- Slides powered by reveal.js
- Image, audio, and video.
- PDF and links.
- Dynamic generated (use Python script).
- Raw HTML.
- Builtin web server
- Basic authentication
- Readonly mode
- RESTful API
- Frontend in browser
- Dynamic markdown rendering
- Builtin reader mode
- Static website generator
For details about features, installation and usage, visit documents website powered by Paperead.
Install
Use pip:
pip install paperead
Usage
paperead new first-material
paperead new first-material -N first-note
paperead serve
# Visit http://localhost:3649
Development
# Run backend
cd src/main
pip install -r requirements.txt
python -m paperead -D "path/to/dataDir" serve
# endpoint: http://localhost:3649/api
# Run frontend
cd src/web
npm install
npm run restore
npm run dev
# endpoint: http://localhost:3600
1 maintainer
Metadata
1 maintainer
Release files for paperead 0.2.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| paperead-0.2.6.tar.gz | 787.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| paperead-0.2.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.6 MB
Release files / paperead-0.2.6.tar.gz
| Download URL | paperead-0.2.6.tar.gz |
|---|---|
| Size | 787.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
07c3243cca2da040ba5af756166bcad5a10a71dae26f6525fde0e4577b26ca67
|
|
BLAKE2b-256 checksum How to use checksums |
e8170b5138542c74e955521b803bab5fa0624826b4501e906946b10b04adb8c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.7.13
|
Release files / paperead-0.2.6-py3-none-any.whl
| Download URL | paperead-0.2.6-py3-none-any.whl |
|---|---|
| Size | 798.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
916dedeabb36b5fd947ac41c8a06b5bb417431b324f3ae9cae2a6e76482d56ac
|
|
BLAKE2b-256 checksum How to use checksums |
f72ec598e1883d04bb2d72fce8175965d331fc1849fd6fc31b6dd750569e626e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.7.13
|
Security for paperead 0.2.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
