This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Reason given by maintainers: We recommend directly using a network library such as Requests.
=======================
This Python package provides a simplified way to interact with the [PDFShift](https://pdfshift.io) API.
## Documentation
See the full documentation on [PDFShift's documentation](https://pdfshift.io/documentation).
## Installation
You should not require this code directly. Instead, just run:
pip install --upgrade pdfshift
or
easy_install --upgrade pdfshift
### Requirements
* Python 2.6+
* [Requests](http://docs.python-requests.org/en/master/)
## Usage
This library needs to be configured with your `api_key` received when creating an account.
Setting it is easy as:
```python
import pdfshift
pdfshift.api_key = '120d8e8a86d2....................'
```
### Basic example
#### With an URL
```python
import pdfshift
pdfshift.api_key = '120d8e8a86d2....................'
binary_file = pdfshift.convert('https://www.example.com')
with open('result.pdf', 'wb') as output:
output.write(binary_file)
```
#### With inline HTML data:
```python
import pdfshift
pdfshift.api_key = '120d8e8a86d2....................'
document = open('invoice.html', 'r')
document_content = document.read()
document.close()
binary_file = pdfshift.convert(document_content)
with open('result.pdf', 'wb') as output:
output.write(binary_file)
```
### Custom CSS
#### Loading CSS from an URL:
```python
import pdfshift
pdfshift.api_key = '120d8e8a86d2....................'
binary_file = pdfshift.convert(
'https://www.example.com',
css="https://www.example.com/public/css/print.css"
)
with open('result.pdf', 'wb') as output:
output.write(binary_file)
```
#### Loading CSS from a string:
```python
import pdfshift
pdfshift.api_key = '120d8e8a86d2....................'
binary_file = pdfshift.convert(
'https://www.example.com',
css="a {text-decoration: underline; color: blue}"
)
with open('result.pdf', 'wb') as output:
output.write(binary_file)
```
### Custom HTTP Headers
```python
import pdfshift
pdfshift.api_key = '120d8e8a86d2....................'
binary_file = pdfshift.convert(
'https://httpbin.org/headers',
headers={
'X-Original-Header': 'Awesome value',
'user-agent': 'Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0'
}
)
with open('result.pdf', 'wb') as output:
output.write(binary_file)
```
### Accessing secured pages
```python
import pdfshift
pdfshift.api_key = '120d8e8a86d2....................'
binary_file = pdfshift.convert('https://httpbin.org/basic-auth/user/passwd', auth=('user', 'passwd'))
with open('result.pdf', 'wb') as output:
output.write(binary_file)
```
### Using cookies
```python
import pdfshift
pdfshift.api_key = '120d8e8a86d2....................'
binary_file = pdfshift.convert(
'https://httpbin.org/cookies',
cookies=[
{'name': 'session', 'value': '4cb496a8-a3eb-4a7e-a704-f993cb6a4dac'}
]
)
with open('result.pdf', 'wb') as output:
output.write(binary_file)
```
### Adding Watermark (Oh hi Mark!)
```python
import pdfshift
pdfshift.api_key = '120d8e8a86d2....................'
binary_file = pdfshift.convert(
'https://www.example.com',
watermark={
'image': 'https://pdfshift.io/static/img/logo.png',
'offset_x': 50,
'offset_y': '100px',
'rotate': 45
}
)
with open('result.pdf', 'wb') as output:
output.write(binary_file)
```
### Custom Header (or Footer)
```python
import pdfshift
pdfshift.api_key = '120d8e8a86d2....................'
binary_file = pdfshift.convert(
'https://www.example.com',
footer={
'source': '<div>Page {{page}} of {{total}}</div>',
'spacing': '50px'
}
)
with open('result.pdf', 'wb') as output:
output.write(binary_file)
```
### Protecting the generated PDF
```python
import pdfshift
pdfshift.api_key = '120d8e8a86d2....................'
binary_file = pdfshift.convert(
'https://www.example.com',
protection={
'user_password': 'user',
'owner_password': 'owner',
'no_print': True
}
)
with open('result.pdf', 'wb') as output:
output.write(binary_file)
```
Metadata
Release files for pdfshift 1.0.4
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 | Actions |
|---|---|---|---|---|
| pdfshift-1.0.4.tar.gz | 5.0 kB | Without provenance | Details for pdfshift-1.0.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pdfshift-1.0.4-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for pdfshift-1.0.4-py2.py3-none-any.whl |
Total release size: 10.7 kB
Release files / pdfshift-1.0.4.tar.gz
| Download URL | pdfshift-1.0.4.tar.gz |
|---|---|
| Size | 5.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d9d76a5da536a05bd862f876acfc28767cdeb6c9549591b4dc8bef0171f2f159
|
|
BLAKE2b-256 checksum How to use checksums |
d8d89fe56ab69f82213e7ae5b8f1db5fb5a11059b103f4f4f8ae264e1c423975
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / pdfshift-1.0.4-py2.py3-none-any.whl
| Download URL | pdfshift-1.0.4-py2.py3-none-any.whl |
|---|---|
| Size | 5.7 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
3293b1b33bab33e438b2a73e0cf7b11936c177aa49a9e9b39ab6b887c435a4c6
|
|
BLAKE2b-256 checksum How to use checksums |
eed6681807a26a6f7078fca7dbe41f15f4127399b2731cc45a623bb5bd6043ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for pdfshift 1.0.4
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.