# LaTeX Document Reader
[](https://badge.fury.io/py/LaTeX-Document-Reader)
[](https://opensource.org/licenses/MIT)
A Python library for reading LaTeX documents and processing BibTeX files.
## Installation
You can install the library using pip:
```shell
pip install latex-document-reader
```
## Usage
Reading LaTeX Documents
To read a LaTeX document, create an instance of the LaTeXDocumentReader class, passing the file path of the document as a parameter. Then, use the read_document method to retrieve the content of the document.
```python
from latex_document_reader import LaTeXDocumentReader
# Create an instance of LaTeXDocumentReader
document_reader = LaTeXDocumentReader('path/to/your/document.tex')
# Read the LaTeX document
content = document_reader.read_document()
# Print the content
print(content)
```
## Reading BibTeX Files
To process a BibTeX file, use the read_bibtex method of the LaTeXDocumentReader class, passing the file path of the BibTeX file as a parameter.
```python
from latex_document_reader import LaTeXDocumentReader
# Create an instance of LaTeXDocumentReader
document_reader = LaTeXDocumentReader('path/to/your/document.tex')
# Read a BibTeX file
bibtex_content = document_reader.read_bibtex('path/to/your/references.bib')
# Print the BibTeX content
print(bibtex_content)
```
## Making the File Human-Readable
The library also provides a make_readable method that can be used to process the content of a LaTeX document or any other text and make it human-readable. You can customize the method according to your specific requirements.
```python
from latex_document_reader import LaTeXDocumentReader
# Create an instance of LaTeXDocumentReader
document_reader = LaTeXDocumentReader('path/to/your/document.tex')
# Read the LaTeX document
content = document_reader.read_document()
# Make the content human-readable
readable_content = document_reader.make_readable(content)
# Print the human-readable content
print(readable_content)
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/ozanil/LaTeXDocumentReader.git",
"name": "latex-document-reader",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "latex document reader bibtex",
"author": "An\u0131l \u00d6Z",
"author_email": "anil.oz@icloud.com",
"download_url": "https://files.pythonhosted.org/packages/da/3f/046db06096667f806d460a5d9040e9f14de71f0aec18e032b5f7c8475f38/latex-document-reader-1.0.1.tar.gz",
"platform": null,
"description": "# LaTeX Document Reader\r\n\r\n[](https://badge.fury.io/py/LaTeX-Document-Reader)\r\n[](https://opensource.org/licenses/MIT)\r\n\r\nA Python library for reading LaTeX documents and processing BibTeX files.\r\n\r\n## Installation\r\n\r\nYou can install the library using pip:\r\n\r\n```shell\r\npip install latex-document-reader\r\n```\r\n\r\n## Usage\r\nReading LaTeX Documents\r\nTo read a LaTeX document, create an instance of the LaTeXDocumentReader class, passing the file path of the document as a parameter. Then, use the read_document method to retrieve the content of the document.\r\n\r\n```python\r\nfrom latex_document_reader import LaTeXDocumentReader\r\n\r\n# Create an instance of LaTeXDocumentReader\r\ndocument_reader = LaTeXDocumentReader('path/to/your/document.tex')\r\n\r\n# Read the LaTeX document\r\ncontent = document_reader.read_document()\r\n\r\n# Print the content\r\nprint(content)\r\n```\r\n\r\n## Reading BibTeX Files\r\nTo process a BibTeX file, use the read_bibtex method of the LaTeXDocumentReader class, passing the file path of the BibTeX file as a parameter.\r\n\r\n```python\r\nfrom latex_document_reader import LaTeXDocumentReader\r\n\r\n# Create an instance of LaTeXDocumentReader\r\ndocument_reader = LaTeXDocumentReader('path/to/your/document.tex')\r\n\r\n# Read a BibTeX file\r\nbibtex_content = document_reader.read_bibtex('path/to/your/references.bib')\r\n\r\n# Print the BibTeX content\r\nprint(bibtex_content)\r\n```\r\n\r\n## Making the File Human-Readable\r\nThe library also provides a make_readable method that can be used to process the content of a LaTeX document or any other text and make it human-readable. You can customize the method according to your specific requirements.\r\n\r\n```python\r\nfrom latex_document_reader import LaTeXDocumentReader\r\n\r\n# Create an instance of LaTeXDocumentReader\r\ndocument_reader = LaTeXDocumentReader('path/to/your/document.tex')\r\n\r\n# Read the LaTeX document\r\ncontent = document_reader.read_document()\r\n\r\n# Make the content human-readable\r\nreadable_content = document_reader.make_readable(content)\r\n\r\n# Print the human-readable content\r\nprint(readable_content)\r\n```\r\n\r\n## License\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python library for reading LaTeX documents and processing BibTeX files",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/ozanil/LaTeXDocumentReader.git"
},
"split_keywords": [
"latex",
"document",
"reader",
"bibtex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f96d74d3af5bf5fa3088ffe2fc08b75941c09c89147ccbfd4318ffe2d0a546b",
"md5": "da5e784a041b097be32f273525515b6f",
"sha256": "3aa4f03b09c85ac68567aeaf11653ac196a01a23c258a7e5fe40bec841609566"
},
"downloads": -1,
"filename": "latex_document_reader-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da5e784a041b097be32f273525515b6f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3938,
"upload_time": "2023-06-20T22:08:01",
"upload_time_iso_8601": "2023-06-20T22:08:01.115130Z",
"url": "https://files.pythonhosted.org/packages/4f/96/d74d3af5bf5fa3088ffe2fc08b75941c09c89147ccbfd4318ffe2d0a546b/latex_document_reader-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da3f046db06096667f806d460a5d9040e9f14de71f0aec18e032b5f7c8475f38",
"md5": "c59fd0646edc497dbdf0b909507877cc",
"sha256": "afc1a81a3a52b1e9189b6cfa44507bc81202f00ec67b7b3b7df2753a95297efc"
},
"downloads": -1,
"filename": "latex-document-reader-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c59fd0646edc497dbdf0b909507877cc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3335,
"upload_time": "2023-06-20T22:08:03",
"upload_time_iso_8601": "2023-06-20T22:08:03.675486Z",
"url": "https://files.pythonhosted.org/packages/da/3f/046db06096667f806d460a5d9040e9f14de71f0aec18e032b5f7c8475f38/latex-document-reader-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-20 22:08:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ozanil",
"github_project": "LaTeXDocumentReader",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "latex-document-reader"
}
JSON
