# remove-bg

**Repository Path**: python_7/remove-bg

## Basic Information

- **Project Name**: remove-bg
- **Description**: A Python API wrapper for removing background using remove.bg's API,移除照片背景。
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-07-31
- **Last Updated**: 2023-07-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# remove-bg
A Python API wrapper for removing backgrounds from picture using remove.bg's API

# License
This code is licensed under the MIT License. See [here](https://github.com/brilam/remove-bg/blob/master/LICENSE) for more details.

# Installation
`pip install removebg`

# How to Use
## `remove_background_from_img_file`

| Parameter     | Required      | Description  |
| ------------- |:-------------:| -------------|
| img_file_path | Y             | the path to the image file      |
| size          | N             | the size of the output image (regular = 0.25 MP, hd = 4 MP, 4k = up to 10 MP). Default value is "regular"|


### Code Example:
```python
from removebg import RemoveBg

rmbg = RemoveBg("YOUR-API-KEY", "error.log")
rmbg.remove_background_from_img_file("joker.jpg")
```


## `remove_background_from_img_url`
| Parameter     | Required      | Description  |
| ------------- |:-------------:| -------------|
| img_url | Y                   | the URL to the image|
| size          | N             | the size of the output image (regular = 0.25 MP, hd = 4 MP, 4k = up to 10 MP). Default value is "regular"|
| new_file_name | N             | the new file name of the image with the background removed |

### Code Example:
```python
from removebg import RemoveBg

rmbg = RemoveBg("YOUR-API-KEY", "error.log")
rmbg.remove_background_from_img_url("http://www.example.com/some_image.jpg")
```


## `remove_background_from_base64_img`
| Parameter     | Required      | Description  |
| ------------- |:-------------:| -------------|
| base64_img    | Y             | the base64 image string|
| size          | N             | the size of the output image (regular = 0.25 MP, hd = 4 MP, 4k = up to 10 MP). Default value is "regular"|
| new_file_name | N             | the new file name of the image with the background removed |

### Code Example:
```python
from removebg import RemoveBg
import base64

rmbg = RemoveBg("YOUR-API-KEY", "error.log")
with open("joker.jpg", "rb") as image_file:
	encoded_string = base64.b64encode(image_file.read())
    rmbg.remove_background_from_base64_img(encoded_string)
```

# Contributions
Contributions and feature requests are always welcome.