diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..e69de29 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..3e7631d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for IMGkit +title: '' +labels: feature request +assignees: '' + +--- + +### Is your feature request related to a problem? +A clear and concise description of the problem, or the problem link. + +### Describe the solution you want +A clear and concise description of what you want. + +### Describe alternatives you have considered +A clear and concise description of alternative solutions or features. + +### Additional context +Other context or screenshots about the feature request. diff --git a/.github/ISSUE_TEMPLATE/help_needed.md b/.github/ISSUE_TEMPLATE/help_needed.md new file mode 100644 index 0000000..8b54274 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help_needed.md @@ -0,0 +1,28 @@ +--- +name: Help needed +about: Problems when using IMGkit +title: '' +labels: help needed +assignees: '' + +--- + +### Describe the problem +A clear and concise description of what the bug is. + +### How To Reproduce +Code and steps. + +### Expected behavior +A clear and concise description of what you expected to happen. + +### Screenshots +If applicable, add screenshots to help explain your problem. + +### Basic information +Platform: +OS & version: +IMGkit version: + +### Additional context +Other context about the problem. diff --git a/.github/pull_request_tempate.md b/.github/pull_request_tempate.md new file mode 100644 index 0000000..acb09ac --- /dev/null +++ b/.github/pull_request_tempate.md @@ -0,0 +1,33 @@ +## Description + + +## Type of change + + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +## How Has This Been Tested? + + + +Travis CI link: + +## Checklist: + + + +- [ ] Added description of this Pull Request +- [ ] Changes of this Pull Request +- [ ] Added tests and example, test must pass +- [ ] Relevant documentation/comments is changed or added diff --git a/README.md b/README.md index 2242b06..14e3688 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Python 2 and 3 wrapper for wkhtmltoimage utility to convert HTML to IMG using We ``` bash sudo apt-get install wkhtmltopdf ``` - + **Warning!** Version in debian/ubuntu repos have reduced functionality (because it compiled without the wkhtmltopdf QT patches), such as adding outlines, headers, footers, TOC etc. To use this options you should install static binary from [wkhtmltopdf](http://wkhtmltopdf.org/) site or you can use this [script](https://github.com/jarrekk/imgkit/blob/master/travis/init.sh). * MacOSX: @@ -41,8 +41,8 @@ Python 2 and 3 wrapper for wkhtmltoimage utility to convert HTML to IMG using We brew install --cask wkhtmltopdf ``` - * Windows and other options: - + * Windows and other options: + Check [wkhtmltopdf homepage](http://wkhtmltopdf.org/) for binary installers or [wiki page](https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF). ## Usage @@ -176,15 +176,15 @@ imgkit.from_string(html_string, output_file, config=config) ## Troubleshooting * `IOError: 'No wkhtmltopdf executable found'`: - + Make sure that you have wkhtmltoimage in your `$PATH` or set via custom configuration (see preceding section). *where wkhtmltoimage* in Windows or *which wkhtmltoimage* on Linux should return actual path to binary. * `IOError: 'No xvfb executable found'`: - + Make sure that you have xvfb-run in your `$PATH` or set via custom configuration (see preceding section). *where xvfb* in Windows or *which xvfb-run* or *which Xvfb* on Linux should return actual path to binary. * `IOError: 'Command Failed'`: - + This error means that IMGKit was unable to process an input. You can try to directly run a command from error message and see what error caused failure (on some wkhtmltoimage versions this can be cause by segmentation faults) ## Credit