Improve docs and github templates
parent
bab6d154c2
commit
7e91d4ec6d
|
@ -1,20 +1,20 @@
|
||||||
---
|
---
|
||||||
name: Bug report
|
name: Bug report
|
||||||
about: Create a report to help us improve
|
about: Report a bug
|
||||||
title: ''
|
title: ''
|
||||||
labels: bug
|
labels: bug
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe the bug**
|
**Bug report**
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
|
|
||||||
**To Reproduce**
|
Thanks for finding the bug! To help us fix it, please make sure that you
|
||||||
|
include the following information:
|
||||||
|
|
||||||
1. If any, include the code that you are using
|
- A description of the bug
|
||||||
2. If any, include the command line statements that you are using
|
- Steps to reproduce the bug. Try to minimize the number of steps needed.
|
||||||
3. If you have problems with a specific pdf file, include that pdf file
|
Include the command and/or script that you use. Also include the PDF that
|
||||||
|
you use.
|
||||||
|
- If relevant, include the output and/or error stacktrace.
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
|
@ -1,17 +1,18 @@
|
||||||
---
|
---
|
||||||
name: Feature request
|
name: Feature request
|
||||||
about: Suggest an improvement for this project
|
about: Request a new feature
|
||||||
title: ''
|
title: ''
|
||||||
labels: enhancement
|
labels: enhancement
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
**Feature request**
|
||||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
|
||||||
|
|
||||||
**Describe the solution you'd like**
|
Thanks for your suggestion on improving pdfminer.six. To helps us discuss and
|
||||||
A clear and concise description of what you want to happen.
|
implement this request, please make sure to include the following information:
|
||||||
|
|
||||||
**Describe alternatives you've considered**
|
- A description of the feature you would like to have
|
||||||
A clear and concise description of any alternative solutions or features you've considered.
|
- If relevant, the context that you are in. What are you trying to achieve?
|
||||||
|
- If possible, an example of what you want to achieve. Include the PDF that
|
||||||
|
you are working on. Include the output that you would like to have.
|
||||||
|
|
|
@ -1,17 +1,30 @@
|
||||||
**Description**
|
**Pull request**
|
||||||
|
|
||||||
Please include a summary of the change and which issue is fixed. If this does not fix an issue, then first create a new issue. Please also include relevant motivation and context.
|
Thanks for improving pdfminer.six! Please include the following information to
|
||||||
|
help us discuss and merge this PR:
|
||||||
|
|
||||||
Fixes # (issue)
|
- A description of why this PR is needed. What does it fix? What does it
|
||||||
|
improve?
|
||||||
|
- A summary of the things that this PR changes.
|
||||||
|
- Reference the issues that this PR fixes (use the fixes #(issue nr) syntax).
|
||||||
|
If this PR does not fix any issue, create the issue first and mention that
|
||||||
|
you are willing to work on it.
|
||||||
|
|
||||||
**How Has This Been Tested?**
|
**How Has This Been Tested?**
|
||||||
|
|
||||||
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Include an example pdf if you have one.
|
Please describe the tests that you ran to verify your changes. Provide
|
||||||
|
instructions so we can reproduce. Include an example pdf if you have one.
|
||||||
|
|
||||||
**Checklist**
|
**Checklist**
|
||||||
|
|
||||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
- [ ] I have added tests that prove my fix is effective or that my feature
|
||||||
- [ ] I have updated the [README.md](../README.md) and other documentation, or I am sure that this is not necessary
|
works
|
||||||
- [ ] I have added a consice human-readable description of the change to [CHANGELOG.md](../CHANGELOG.md)
|
|
||||||
- [ ] I have added docstrings to newly created methods and classes
|
- [ ] I have added docstrings to newly created methods and classes
|
||||||
- [ ] I have optimized the code at least one time after creating the initial version
|
- [ ] I have optimized the code at least one time after creating the initial
|
||||||
|
version
|
||||||
|
- [ ] I have updated the [README.md](../README.md) or I am verified that this
|
||||||
|
is not necessary
|
||||||
|
- [ ] I have updated the [readthedocs](../docs/source) documentation or I
|
||||||
|
verified that this is not necessary
|
||||||
|
- [ ] I have added a consice human-readable description of the change to
|
||||||
|
[CHANGELOG.md](../CHANGELOG.md)
|
||||||
|
|
|
@ -15,6 +15,7 @@ Any contribution is appreciated! You might want to:
|
||||||
issue.
|
issue.
|
||||||
* Fix issues by [creating pull requests](https://help.github.com/en/articles/creating-a-pull-request).
|
* Fix issues by [creating pull requests](https://help.github.com/en/articles/creating-a-pull-request).
|
||||||
* Help others by sharing your thoughs in comments on issues and pull requests.
|
* Help others by sharing your thoughs in comments on issues and pull requests.
|
||||||
|
* Join the chat on [gitter](https://gitter.im/pdfminer-six/Lobby)
|
||||||
|
|
||||||
## Guidelines for creating issues
|
## Guidelines for creating issues
|
||||||
|
|
||||||
|
|
23
README.md
23
README.md
|
@ -5,15 +5,15 @@ pdfminer.six
|
||||||
[![PyPI version](https://img.shields.io/pypi/v/pdfminer.six.svg)](https://pypi.python.org/pypi/pdfminer.six/)
|
[![PyPI version](https://img.shields.io/pypi/v/pdfminer.six.svg)](https://pypi.python.org/pypi/pdfminer.six/)
|
||||||
[![gitter](https://badges.gitter.im/pdfminer-six/Lobby.svg)](https://gitter.im/pdfminer-six/Lobby?utm_source=badge&utm_medium)
|
[![gitter](https://badges.gitter.im/pdfminer-six/Lobby.svg)](https://gitter.im/pdfminer-six/Lobby?utm_source=badge&utm_medium)
|
||||||
|
|
||||||
Pdfminer.six is an community maintained fork of the original PDFMiner. It is a
|
Pdfminer.six is a community maintained fork of the original PDFMiner. It is a
|
||||||
tool for extracting information from PDF documents.
|
tool for extracting information from PDF documents. It focuses on getting
|
||||||
Unlike other PDF-related tools, it focuses entirely on getting
|
and analyzing text data. Pdfminer.six extracts the text from a page directly
|
||||||
and analyzing text data. Pdfminer.six allows one to obtain
|
from the sourcecode of the PDF. It can also be used to get the exact location,
|
||||||
the exact location of text in a page, as well as
|
font or color of the text.
|
||||||
other information such as fonts or lines.
|
|
||||||
It includes a PDF converter that can transform PDF files
|
It is build in a modular way such that each component of pdfminer.six can be
|
||||||
into other text formats (such as HTML). It has an extensible
|
replaced easily. You can inmplement your own interpreter or rendering device
|
||||||
PDF parser that can be used for other purposes than text analysis.
|
to use the power of pdfminer.six for other purposes that text analysis.
|
||||||
|
|
||||||
Check out the full documentation on
|
Check out the full documentation on
|
||||||
[Read the Docs](https://pdfminersix.readthedocs.io).
|
[Read the Docs](https://pdfminersix.readthedocs.io).
|
||||||
|
@ -29,7 +29,7 @@ Features
|
||||||
* Various font types (Type1, TrueType, Type3, and CID) support.
|
* Various font types (Type1, TrueType, Type3, and CID) support.
|
||||||
* Support for extracting images (JPG, JBIG2 and Bitmaps).
|
* Support for extracting images (JPG, JBIG2 and Bitmaps).
|
||||||
* Support for RC4 and AES encryption.
|
* Support for RC4 and AES encryption.
|
||||||
* Outline (TOC) extraction.
|
* Table of contents extraction.
|
||||||
* Tagged contents extraction.
|
* Tagged contents extraction.
|
||||||
* Automatic layout analysis.
|
* Automatic layout analysis.
|
||||||
|
|
||||||
|
@ -45,9 +45,6 @@ How to use
|
||||||
* Use command-line interface to extract text from pdf:
|
* Use command-line interface to extract text from pdf:
|
||||||
|
|
||||||
`python pdf2txt.py samples/simple1.pdf`
|
`python pdf2txt.py samples/simple1.pdf`
|
||||||
|
|
||||||
* Check out more examples and documentation on
|
|
||||||
[Read the Docs](https://pdfminersix.readthedocs.io).
|
|
||||||
|
|
||||||
|
|
||||||
Contributing
|
Contributing
|
||||||
|
|
|
@ -19,3 +19,10 @@ extract_text_to_fp
|
||||||
|
|
||||||
.. currentmodule:: pdfminer.high_level
|
.. currentmodule:: pdfminer.high_level
|
||||||
.. autofunction:: extract_text_to_fp
|
.. autofunction:: extract_text_to_fp
|
||||||
|
|
||||||
|
|
||||||
|
extract_pages
|
||||||
|
=============
|
||||||
|
|
||||||
|
.. currentmodule:: pdfminer.high_level
|
||||||
|
.. autofunction:: extract_pages
|
Loading…
Reference in New Issue