Python API for Pagefind
Project description
pagefind
An async python API for the pagefind binary.
Installation
python3 -m pip install 'pagefind[bin]'
python3 -m pagefind --help
Usage
import asyncio
import json
import logging
import os
from pagefind.index import PagefindIndex, IndexConfig
logging.basicConfig(level=os.environ.get("LOG_LEVEL", "INFO"))
log = logging.getLogger(__name__)
html_content = (
"<html>"
" <body>"
" <main>"
" <h1>Example HTML</h1>"
" <p>This is an example HTML page.</p>"
" </main>"
" </body>"
"</html>"
)
def prefix(pre: str, s: str) -> str:
return pre + s.replace("\n", f"\n{pre}")
async def main():
config = IndexConfig(
root_selector="main", logfile="index.log", output_path="./output", verbose=True
)
async with PagefindIndex(config=config) as index:
log.debug("opened index")
new_file, new_record, new_dir = await asyncio.gather(
index.add_html_file(
content=html_content,
url="https://example.com",
source_path="other/example.html",
),
index.add_custom_record(
url="/elephants/",
content="Some testing content regarding elephants",
language="en",
meta={"title": "Elephants"},
),
index.add_directory("./public"),
)
print(prefix("new_file ", json.dumps(new_file, indent=2)))
print(prefix("new_record ", json.dumps(new_record, indent=2)))
print(prefix("new_dir ", json.dumps(new_dir, indent=2)))
files = await index.get_files()
for file in files:
print(prefix("files", f"{len(file['content']):10}B {file['path']}"))
if __name__ == "__main__":
asyncio.run(main())
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pagefind-1.5.0b2.tar.gz
(46.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pagefind-1.5.0b2.tar.gz.
File metadata
- Download URL: pagefind-1.5.0b2.tar.gz
- Upload date:
- Size: 46.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b838d2c5a4ec5836294fa54af66b4210568a97635093c43b915d67ccb589378f
|
|
| MD5 |
2be25fc2bf277fc7008a206ca89338ee
|
|
| BLAKE2b-256 |
c81bd88d8d7fe3628e705c154b5b14bd4ddc5204b5fd155ce1aee48099fc6485
|
Provenance
The following attestation bundles were made for pagefind-1.5.0b2.tar.gz:
Publisher:
release.yml on Pagefind/pagefind
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pagefind-1.5.0b2.tar.gz -
Subject digest:
b838d2c5a4ec5836294fa54af66b4210568a97635093c43b915d67ccb589378f - Sigstore transparency entry: 1229986247
- Sigstore integration time:
-
Permalink:
Pagefind/pagefind@85912c0fd8ca425a663151787309608ca7930398 -
Branch / Tag:
refs/tags/v1.5.0-beta.2 - Owner: https://github.com/Pagefind
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@85912c0fd8ca425a663151787309608ca7930398 -
Trigger Event:
push
-
Statement type:
File details
Details for the file pagefind-1.5.0b2-py3-none-any.whl.
File metadata
- Download URL: pagefind-1.5.0b2-py3-none-any.whl
- Upload date:
- Size: 10.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2798b4f75134ba57197b93a6d7eb8e726be8d0eb86932f5ace72c0e5c8f1e637
|
|
| MD5 |
2809b553dd0916ff51eda3086f2187e4
|
|
| BLAKE2b-256 |
8bff7f5f9a551f53c0c2f247d216b0e9ba6f50954abb6266edc495a1e2f4082a
|
Provenance
The following attestation bundles were made for pagefind-1.5.0b2-py3-none-any.whl:
Publisher:
release.yml on Pagefind/pagefind
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pagefind-1.5.0b2-py3-none-any.whl -
Subject digest:
2798b4f75134ba57197b93a6d7eb8e726be8d0eb86932f5ace72c0e5c8f1e637 - Sigstore transparency entry: 1229986278
- Sigstore integration time:
-
Permalink:
Pagefind/pagefind@85912c0fd8ca425a663151787309608ca7930398 -
Branch / Tag:
refs/tags/v1.5.0-beta.2 - Owner: https://github.com/Pagefind
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@85912c0fd8ca425a663151787309608ca7930398 -
Trigger Event:
push
-
Statement type:
