rem

removebg

A Python API wrapper for removing background using remove.bg's API

Showing:

Popularity

Downloads/wk

0

GitHub Stars

653

Maintenance

Last Commit

10mos ago

Contributors

6

Package

Dependencies

0

License

MIT

Categories

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 for more details.

Installation

pip install removebg

Usage

remove_background_from_img_file

Removes the background given an image file.

ParameterDefault ValueDescription
img_file_pathreq. parampath to the source image file
size'regular'size of the output image ('auto' = highest available resolution, 'preview'
type'auto'foreground object ('auto' = autodetect, 'person', 'product', 'car')
type_level'none'classification level of the foreground object ('none' = no classification, '1' = coarse classification (e.g. 'car'), '2' = specific classification (e.g. 'car_interior'), 'latest' = latest classification)
format'auto'image format ('auto' = autodetect, 'png', 'jpg', 'zip')
roi'0 0 100% 100%'region of interest, where to look for foreground object (x1, y1, x2, y2) in px or relative (%)
cropNonepx or relative, single val = all sides, two vals = top/bottom, left/right, four vals = top, right, bottom, left
scale'original'image scale relative to the total image size
position'original''center', 'original', single val = horizontal and vertical, two vals = horizontal, vertical
channels'rgba'request the finalized image ('rgba') or an alpha mask ('alpha')
shadowFalsewhether to add an artificial shadow (some types aren't supported)
semitransparencyTruesemitransparency for windows or glass objects (some types aren't supported)
bgNonebackground (None = no background, path, url, color hex code (e.g. '81d4fa', 'fff'), color name (e.g. 'green'))
bg_typeNonebackground type (None = no background, 'path', 'url', 'color')
new_file_name'no-bg.png'file name of the result image

Code Example:

from removebg import RemoveBg

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

remove_background_from_img_url

Removes the background given an image URL.

ParameterDefault ValueDescription
img_urlreq. paramURL to the source image
size'regular'size of the output image ('auto' = highest available resolution, 'preview'
type'auto'foreground object ('auto' = autodetect, 'person', 'product', 'car')
type_level'none'classification level of the foreground object ('none' = no classification, '1' = coarse classification (e.g. 'car'), '2' = specific classification (e.g. 'car_interior'), 'latest' = latest classification)
format'auto'image format ('auto' = autodetect, 'png', 'jpg', 'zip')
roi'0 0 100% 100%'region of interest, where to look for foreground object (x1, y1, x2, y2) in px or relative (%)
cropNonepx or relative, single val = all sides, two vals = top/bottom, left/right, four vals = top, right, bottom, left
scale'original'image scale relative to the total image size
position'original''center', 'original', single val = horizontal and vertical, two vals = horizontal, vertical
channels'rgba'request the finalized image ('rgba') or an alpha mask ('alpha')
shadowFalsewhether to add an artificial shadow (some types aren't supported)
semitransparencyTruesemitransparency for windows or glass objects (some types aren't supported)
bgNonebackground (None = no background, path, url, color hex code (e.g. '81d4fa', 'fff'), color name (e.g. 'green'))
bg_typeNonebackground type (None = no background, 'path', 'url', 'color')
new_file_name'no-bg.png'file name of the result image

Code Example:

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

Removes the background given a base64 image string.

ParameterDefault ValueDescription
base64_imgreq. parambase64 image string
size'regular'size of the output image ('auto' = highest available resolution, 'preview'
type'auto'foreground object ('auto' = autodetect, 'person', 'product', 'car')
type_level'none'classification level of the foreground object ('none' = no classification, '1' = coarse classification (e.g. 'car'), '2' = specific classification (e.g. 'car_interior'), 'latest' = latest classification)
format'auto'image format ('auto' = autodetect, 'png', 'jpg', 'zip')
roi'0 0 100% 100%'region of interest, where to look for foreground object (x1, y1, x2, y2) in px or relative (%)
cropNonepx or relative, single val = all sides, two vals = top/bottom, left/right, four vals = top, right, bottom, left
scale'original'image scale relative to the total image size
position'original''center', 'original', single val = horizontal and vertical, two vals = horizontal, vertical
channels'rgba'request the finalized image ('rgba') or an alpha mask ('alpha')
shadowFalsewhether to add an artificial shadow (some types aren't supported)
semitransparencyTruesemitransparency for windows or glass objects (some types aren't supported)
bgNonebackground (None = no background, path, url, color hex code (e.g. '81d4fa', 'fff'), color name (e.g. 'green'))
bg_typeNonebackground type (None = no background, 'path', 'url', 'color')
new_file_name'no-bg.png'file name of the result image

Code Example:

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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100