Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rpakishore/ak_pdf
PDF Parser/Creator Library
https://github.com/rpakishore/ak_pdf
Last synced: 2 days ago
JSON representation
PDF Parser/Creator Library
- Host: GitHub
- URL: https://github.com/rpakishore/ak_pdf
- Owner: rpakishore
- License: mit
- Created: 2023-11-03T22:10:26.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-04T23:34:25.000Z (about 1 year ago)
- Last Synced: 2024-11-10T10:42:09.257Z (about 1 month ago)
- Language: Python
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
AK_PDF
Library to Parse/Edit/Create/Read PDF documents
View Demo
·
Documentation
·
Report Bug
·
Request Feature
Table of Contents
- [1. About the Project](#1-about-the-project)
- [1.1. Screenshots](#11-screenshots)
- [1.2. Features](#12-features)
- [2. Getting Started](#2-getting-started)
- [2.1. Prerequisites](#21-prerequisites)
- [2.2. Installation](#22-installation)
- [2.2.1. Production](#221-production)
- [2.2.2. Development](#222-development)
- [3. Usage](#3-usage)
- [4. Roadmap](#4-roadmap)
- [5. FAQ](#5-faq)
- [6. License](#6-license)
- [7. Contact](#7-contact)
- [8. Acknowledgements](#8-acknowledgements)
## 1. About the Project
### 1.1. Screenshots
### 1.2. Features
- Read contents of existing PDFs
- Cache results for improved performance
- Feature 3
## 2. Getting Started
### 2.1. Prerequisites
Python 3.11 or above
### 2.2. Installation
#### 2.2.1. Production
Install directly from pip
```bash
pip install ak_pdf
```
#### 2.2.2. Development
Download the git and install via flit
```bash
git clone https://github.com/rpakishore/ak_pdf.git
cd ak_pdf
pip install flit
flit install
```
## 3. Usage
Reader Functionality
```python
from ak_pdf import Reader, debug
debug(True) #For debug messages, Can be skipped.
# Initialize
pdf = Reader(filepath=r"textbook.pdf", password=None)
## Document metadata
pdf.metadata
## Check if pdf is encrypted
pdf.encrypted
## get number of pages
pdf.num_pages
## get list of page objects
pdf.pages #list[PageObjects]
## get page text
pdf.text(10) #gets text from 11th page (page_idx=10); Results cached
## get images from page
pdf.images(page_idx=10) #List of PIL Image Objects from 11th page
## Extract and save images
pdf.save_images(page_idx=10, folderpath='C:\\')
## get pagelabel
pdf.page_number(page_idx=10) #or
pdf.page_number(page=pdf.pages[10])
```
Writer Functionality
```python
```
## 4. Roadmap
- [x] Reader/Parser
- [ ] Creator Template
- [ ] Modification of Existing PDFs
## 5. FAQ
- Question 1
- Answer 1
## 6. License
See LICENSE for more information.
## 7. Contact
Arun Kishore - [@rpakishore](mailto:[email protected])
Project Link: [https://github.com/rpakishore/ak_pdf](https://github.com/rpakishore/ak_pdf)
## 8. Acknowledgements
- [Shields.io](https://shields.io/)