Skip to content

Commit

Permalink
Further documentation and updates the changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
stumpylog committed Oct 12, 2023
1 parent b20bfb3 commit 5ea2904
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- TBD
- Chromium conversion routes
- LibreOffice conversion routes
- PDF/A conversion route
- PDF merge route
- Health status route
- Testing and typing all setup and passing
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Gotenberg API Client

[![PyPI - Version](https://img.shields.io/pypi/v/-.svg)](https://pypi.org/project/gotenberg-client)
[![PyPI - Version](https://img.shields.io/pypi/v/gotenberg-client.svg)](https://pypi.org/project/gotenberg-client)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/gotenberg-client.svg)](https://pypi.org/project/gotenberg-client)

---
Expand All @@ -12,7 +12,7 @@
- [Why](#why)
- [Features](#features)
- [How](#how)
- [Examples](#examplesV)
- [Examples](#examples)
- [License](#license)

## Installation
Expand All @@ -24,16 +24,17 @@ pip install gotenberg-client
## What

This is a Python client for interfacing with [Gotenberg](https://gotenberg.dev/), which in turn is a wrapper around
powerful tools for PDF generation and creation in various ways.
powerful tools for PDF generation and creation in various ways, using a stateless API. It's a very powerful tool
to generate and manipulate PDFs.

## Why

As far as I can tell, no Python library exists to interface with the Gotenberg API.
As far as I can tell, no active Python library exists to interface with the Gotenberg API.

### Features

- HTTP/2 enabled by default
- Abstract away the handling of multi-part/form-data and deal with files instead
- Abstract away the handling of multi-part/form-data and deal with `Path`s instead
- Based on the modern [httpx](https://github.com/encode/httpx) library
- Full support for type hinting and concrete return types as mush as possible
- Nearly full test coverage run against an actual Gotenberg server for multiple Python and PyPy versions
Expand All @@ -47,7 +48,8 @@ endpoint. All the routes use the same format and general idea.
1. Then, configure the endpoint with its various options the route supports
1. Finally, run the route and receive your resulting file

- Files will be PDF or ZIP, depending on what endpoint and its configure
- Files will be PDF or ZIP, depending on what endpoint and its configuration. Endpoints which handle
multiple files, but don't merge them, return a ZIP archive of the resulting PDFs

### Examples

Expand Down

0 comments on commit 5ea2904

Please sign in to comment.