Skip to content

Commit

Permalink
github template
Browse files Browse the repository at this point in the history
  • Loading branch information
jarrekk committed Mar 29, 2021
1 parent 091e37c commit 03be520
Show file tree
Hide file tree
Showing 5 changed files with 87 additions and 6 deletions.
Empty file.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/help_needed.md
Original file line number Diff line number Diff line change
@@ -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.
33 changes: 33 additions & 0 deletions .github/pull_request_tempate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## Description
<!--
YOU ARE WELCOME TO CREATE PULL REQUEST!
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
-->

## Type of change
<!--
Please delete options that are not relevant. For completed items, change [ ] to [x].
-->

- [ ] 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?

<!--
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
-->

Travis CI link:

## Checklist:

<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->

- [ ] 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
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 03be520

Please sign in to comment.