Skip to content

Commit

Permalink
Update Python and Pillow versions
Browse files Browse the repository at this point in the history
  • Loading branch information
ShortArrow committed Jan 5, 2024
1 parent c188ede commit 40703e3
Show file tree
Hide file tree
Showing 4 changed files with 517 additions and 398 deletions.
35 changes: 22 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# What is pyxlimg

Pyxlimg is for extracting images from xlsx. It has a high affinity with other libraries. This is because you can treat the image as an instance of Pillow.Image. I hope it will be incorporated into openpyxl and pylightxl in the future.
Pyxlimg is for extracting images from xlsx. It has a high affinity with other libraries. This is because you can treat the image as an instance of Pillow.Image.

# Concept
## Concept

Images are difficult to handle with xlwings, openpyxl, and pylightxl. Especially linter and type annotation are difficult. Complement these. And the goal is to make it easier to do OCR etc. using xlsx in Python.

# Install
## Install

Recommended to install using pip.

```sh
pip install pyxlimg
```

# Usage
## Usage

```py
from PIL import Image
Expand All @@ -40,32 +40,41 @@ In this way, you can easily assign images to variable.
DisplayImage.show() # Show you the Image too.
```

# FAQ
## FAQ

## What image format does this support?
If it is supported by [Pillow](https://pypi.org/project/Pillow/), it can be supported. If the original image is in a commonly used format such as png, jpg, bmp when pasted or inserted into xlsx.
### What image format does this support?

## What kind of library is this supposed to be used with?
For example, `Tesseract OCR`, `pylightxl`, `openpyxl`, `matplotlib`. It is also ideal for matching with other `pillow` related libraries.
If it is supported by [Pillow](https://pypi.org/project/Pillow/), it can be supported. If the original image is in a commonly used format such as png, jpg, bmp when pasted or inserted into xlsx.

# How to Contribute
### What kind of library is this supposed to be used with?

Please do a git clone and pull request. The version control tool used in this repository is poetry.
For example, `Tesseract OCR`, `pylightxl`, `openpyxl`, `matplotlib`. It is also ideal for matching with other `pillow` related libraries.

## Build

How to build package.

```
```bash
poetry install
poetry shell
poetry build
```

How to build sphinx docs.

```
```bash
poetry export --with dev -f requirements.txt > requirements.txt
sphinx-apidoc -f -o ./docs ./pyxlimg
sphinx-build -b html ./docs ./docs/_build
```

In Windows

```pwsh
pyenv install 3.11.0
pyenv local 3.11.0
poetry install
poetry shell
pytest
poetry build
```
Loading

0 comments on commit 40703e3

Please sign in to comment.