Skip to main content

Converting PDF files to text, mainly with a focus on arXiv papers.

Project description

Development Status :: 3 - Alpha

arxiv2text

PyPI package Code style: black

A Python package that converts arXiv documents into structured text using arXiv PDF URLs. If it's a PDF link other than arXiv, it's mostly feasible. If extraction to markdown fails, try extracting to text or HTML.


Install

$ pip install arxiv2text
$ pip install git+https://github.com/dsdanielpark/arxiv2text.git

Usage

arxiv_to_text

from arxiv2text import arxiv_to_text

pdf_url = "https://arxiv.org/pdf/1706.03762"

extracted_text = arxiv_to_text(pdf_url, output_dir) # output_dir is optional argument

arxiv_to_html

from arxiv2text import arxiv_to_html

pdf_url = "https://arxiv.org/pdf/1706.03762"

output_dir = "output_folder"
arxiv_to_html(pdf_url, output_dir)

arxiv_to_md

from arxiv2text import arxiv_to_md

pdf_url = "https://arxiv.org/pdf/1706.03762"

output_dir = "output_folder"
arxiv_to_md(pdf_url, output_dir)

arXiv API

import urllib.request as libreq
with libreq.urlopen('http://export.arxiv.org/api/query?search_query=all:electron&start=0&max_results=1') as url:
  r = url.read()
print(r)

License

MIT

The MIT License (MIT)

Copyright (c) 2023 Minwoo Park

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Bugs and Issues

Sincerely grateful for any reports on new features or bugs. Your valuable feedback on the code is highly appreciated.

Contacts

Copyright (c) 2023 MinWoo Park, South Korea

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arxiv2text-0.1.14.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

arxiv2text-0.1.14-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file arxiv2text-0.1.14.tar.gz.

File metadata

  • Download URL: arxiv2text-0.1.14.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for arxiv2text-0.1.14.tar.gz
Algorithm Hash digest
SHA256 bebc6de45cbca9ce8f44478c83871c265e8e4d85ec55e2b74035ce0b593cc817
MD5 322970eb06deba5fbfb90f7f80248f85
BLAKE2b-256 684af6f92e10f9d51df40cdf6774c6fa308f381c2724df7f4ccae59c033b81f4

See more details on using hashes here.

File details

Details for the file arxiv2text-0.1.14-py3-none-any.whl.

File metadata

  • Download URL: arxiv2text-0.1.14-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for arxiv2text-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 3ff3aafad181dcfc03667cd184432a55cb9a1b16c1b9ff64eda15555a88f066d
MD5 be0d7cd82c2fe837a797c21cc22ef10e
BLAKE2b-256 9afa9714d0c7f73dd435566515a50ecde9db313bfe0cce8bdcb457edf087a7f4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page