remove-background-ai 0.1.0__tar.gz

remove_background_ai-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Nick Powell
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

remove_background_ai-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+prune tests

remove_background_ai-0.1.0/PKG-INFO

@@ -0,0 +1,293 @@
+Metadata-Version: 2.4
+Name: remove-background-ai
+Version: 0.1.0
+Summary: Remove image backgrounds with OpenAI's GPT Image 2.5 and get a transparent PNG
+Author-email: Nick Powell <hey+remove-background-ai@nickmp.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/nmpowell/remove-background-ai
+Project-URL: Issues, https://github.com/nmpowell/remove-background-ai/issues
+Project-URL: Changelog, https://github.com/nmpowell/remove-background-ai/releases
+Keywords: background-removal,openai,gpt-image,transparent-png,cli
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Typing :: Typed
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click<9,>=8.5
+Requires-Dist: openai<4,>=3.19.2
+Requires-Dist: pillow<13,>=12.3
+Requires-Dist: pydantic<3,>=2.13
+Dynamic: license-file
+
+# remove-background-ai
+
+Remove the background from a photo with OpenAI's GPT Image 2.5 and get a transparent PNG, from the command line or from Python.
+
+```bash
+export OPENAI_API_KEY=sk-...
+uvx remove-background-ai photo.jpg
+```
+
+That writes `photo-no-bg.png` next to `photo.jpg`: your original pixels, at their original size, with the background made transparent.
+
+> ⚠️ Much of this is AI-generated, and not formally reviewed by hand or eye. It's published chiefly for myself: for my own reference, use, and for experimentation with the whole open-source publishing process. I also *use* this code: I dogfood it. It works, for me. I also write tests, and run them to check that it works, and does what it says.
+
+## Installation
+
+Run it without installing, with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uvx remove-background-ai photo.jpg
+```
+
+Or install it:
+
+```bash
+pip install remove-background-ai
+```
+
+It needs Python 3.14 or later and an OpenAI API key with access to the GPT Image 2.5 models. Set the key in the `OPENAI_API_KEY` environment variable; the command has no option for it. The OpenAI SDK's other variables, such as `OPENAI_BASE_URL`, `OPENAI_ORG_ID` and `OPENAI_PROJECT_ID`, work too.
+
+Every image is a paid API call, billed by tokens. See [OpenAI's pricing](https://developers.openai.com/api/docs/pricing). The free tier cannot use GPT Image 2.5. A paid tier can, and OpenAI may ask you to verify your organisation first.
+
+## Usage
+
+Remove the background from one image:
+
+```bash
+remove-background-ai photo.jpg
+```
+
+Say what to keep when the photo has more than one candidate subject, and what else to remove:
+
+```bash
+remove-background-ai shelf.jpg --keep "the red backpack, including both straps" \
+  --remove "the stand and its shadow on the floor"
+```
+
+Process several images into a directory, and get the results as JSON:
+
+```bash
+remove-background-ai *.jpg --output-dir cutouts --json
+```
+
+Choose where one image goes, or replace an existing output:
+
+```bash
+remove-background-ai photo.jpg -o cutout.png --force
+```
+
+Keep the model's own image instead of your original pixels (see [How it works](#how-it-works)):
+
+```bash
+remove-background-ai photo.jpg --mode generated
+```
+
+Use the faster model at a lower quality:
+
+```bash
+remove-background-ai photo.jpg --model gpt-image-2.5-flare-2026-09-08 --quality medium
+```
+
+The command prints each output path on standard output, one per line, and its progress and errors on standard error. It never overwrites a file unless you pass `--force`, and it checks for an existing output before it spends money on an API call.
+
+## How it works
+
+The command sends your image to the [image edit endpoint](https://developers.openai.com/api/reference/python/resources/images/methods/edit) with a prompt that says what to keep and what to remove, and asks for a PNG with a transparent background. There is no dedicated background-removal endpoint: GPT Image 2.5 redraws the image with the background removed.
+
+The model redraws the whole image, so it can soften a label, move an edge or change a texture. By default the command keeps only the model's transparency and puts it on your original pixels. You choose between two output modes:
+
+| Mode | What you get | Size |
+| --- | --- | --- |
+| `original` (default) | Your pixels, with the model's alpha channel | Your image's size |
+| `generated` | The PNG the model returned, byte for byte | The size sent to the model |
+
+In `original` mode the transparency is still the model's work. An edge can land a few pixels off, and a thin band of the old background can survive along the subject's outline: in testing, a strip of brick wall stayed along the top of a backpack. `generated` mode gives cleaner edges, because the model redraws them. Look at the result on a dark and a light backdrop before you rely on it. `generated` mode keeps the provenance metadata (C2PA) that OpenAI embeds in the PNG. `original` mode writes a new file, so that metadata is lost.
+
+### Image sizes
+
+GPT Image 2.5 only produces images whose width and height are multiples of 16, with an aspect ratio no wider than 3:1 and an area of 655,360 to 8,294,400 pixels. Anything over 3,686,400 pixels (2560×1440) is experimental. The command sends your image at the nearest size the model can produce, never an experimental one, and scales the returned transparency back to your image's size.
+
+| Your image | Sent to the model | Why |
+| --- | --- | --- |
+| 1024×1024 | 1024×1024 | Already a size the model produces |
+| 1920×1080 | 1920×1088 | 1080 is not a multiple of 16 |
+| 512×512 | 816×816 | Below the minimum area |
+| 6000×4000 | 2336×1552 | Above the largest standard area |
+| 3000×900 | refused | Wider than 3:1 |
+
+Sending 1920×1080 as 1920×1088 changes the aspect ratio slightly. Scaling the transparency back to 1920×1080 undoes that change, so the cutout does not shift.
+
+The command first turns the image upright using its EXIF orientation. It accepts any format Pillow can open (JPEG, PNG, WebP, TIFF and others) in any colour mode, and always writes an 8-bit RGBA PNG. If your image already has transparency, the output never makes it more opaque. An embedded RGB colour profile goes to the model with the image and stays in the `original` output. Other profiles would describe the wrong colours after conversion, so they are dropped. CMYK images are converted to RGB without colour management, so their colours can shift; convert them to RGB yourself first if colour matters. EXIF data is not copied. Animated images are refused.
+
+### Masks
+
+If the model keeps the wrong thing, give it a mask: an image the same size as the photo (after EXIF rotation), white where the subject is and black elsewhere.
+
+```bash
+remove-background-ai photo.jpg --mask subject.png
+```
+
+Grey at half intensity or brighter counts as white. The mask guides the model, which can still stray over its edges.
+
+## JSON output
+
+`--json` replaces the list of paths with one JSON array. Each image gets an object, in the order given, whether it succeeded or failed:
+
+```json
+[
+  {
+    "input": "mug.jpg",
+    "output": "mug-no-bg.png",
+    "mode": "original",
+    "model": "gpt-image-2.5-sunburst-2026-09-08",
+    "quality": "medium",
+    "source_size": "1300x1132",
+    "model_size": "1312x1136",
+    "output_size": "1300x1132",
+    "request_id": "req_e4351b4660894c96ad6f08a86fc013aa",
+    "usage": {
+      "input_tokens": 1618,
+      "output_tokens": 440,
+      "total_tokens": 2058,
+      "input_tokens_details": {"image_tokens": 1476, "text_tokens": 142},
+      "output_tokens_details": {"image_tokens": 440, "text_tokens": 0}
+    }
+  },
+  {
+    "input": "broken.png",
+    "error": "broken.png cannot be read as an image: cannot identify image file 'broken.png'"
+  }
+]
+```
+
+`usage` is whatever token counts the API reported, or `null`. Errors also go to standard error, so keep the two streams apart when you parse the JSON.
+
+## Exit codes
+
+| Code | Meaning |
+| --- | --- |
+| 0 | Every image succeeded |
+| 1 | Interrupted (Ctrl-C), or a broken pipe |
+| 2 | The command line was wrong: an unknown option, a missing file, `-o` or `--mask` with several images, `-o` with `--output-dir`, an output that is also an input or the mask, or two images that would write the same output |
+| 3 | The tool refused an image or an output before or after the API call: it cannot be read, is animated, is wider than 3:1, its mask does not match, or the output exists or cannot be written |
+| 4 | The OpenAI call failed or returned an unusable image, or `OPENAI_API_KEY` is not set |
+
+With several images the command carries on after a failure. If any image failed, it exits with 4 when at least one failure was an API failure, and 3 otherwise.
+
+## Timeouts and retries
+
+The OpenAI client waits up to 300 seconds on each network operation and retries twice after a rate limit, a server error, a dropped connection or a timeout, pausing between attempts as the server asks. There is no overall deadline, so a slow image can take many minutes. A retried request can be billed more than once, because the server may have finished the first attempt.
+
+## Python library
+
+```python
+from pathlib import Path
+
+from remove_background_ai import RemovalOptions, remove_background
+
+cutout = remove_background(
+    Path("photo.jpg"),
+    options=RemovalOptions(keep="the red backpack", quality="medium"),
+)
+Path("photo-no-bg.png").write_bytes(cutout.png)
+print(cutout.model_size, cutout.request_id)
+```
+
+`remove_background` validates its arguments with Pydantic and raises `pydantic.ValidationError` for the wrong types. It takes a `Path` (not a `str`) as its only positional argument; `options`, `mask` and `editor` are keyword-only. `RemovalOptions` takes `model` (default `gpt-image-2.5-sunburst-2026-09-08`), `quality` (`low`, `medium`, `high`, `xhigh`, `max` or `auto`; default `high`), `mode` (`original` or `generated`), `keep` and `remove`.
+
+It returns a `Cutout` holding the PNG bytes and their metadata; `cutout.model_dump(mode="json")` gives the metadata shown under [JSON output](#json-output), without the image. It raises `InvalidInputError` when it refuses an image and `EditError` when the API call fails; both are `RemoveBackgroundError`s.
+
+To change the timeout or retries, pass your own client:
+
+```python
+from pathlib import Path
+
+from openai import OpenAI
+
+from remove_background_ai import OpenAIImageEditor, remove_background
+
+editor = OpenAIImageEditor(OpenAI(timeout=600, max_retries=0))
+cutout = remove_background(Path("photo.jpg"), editor=editor)
+```
+
+Any object with an `edit(EditRequest) -> EditResponse` method can stand in for `OpenAIImageEditor`, which is how the tests run without the API.
+
+## CLI reference
+
+<!-- [[[cog
+import cog
+from click.testing import CliRunner
+from remove_background_ai.cli import cli
+
+result = CliRunner().invoke(cli, ["--help"], terminal_width=88)
+assert result.exit_code == 0, result.output
+cog.out("```\n" + result.stdout.replace("Usage: cli", "Usage: remove-background-ai") + "```\n")
+]]] -->
+```
+Usage: remove-background-ai [OPTIONS] IMAGES...
+
+  Send each image to GPT Image 2.5 and write a transparent PNG. By default, the result
+  keeps the original pixels and size and takes only transparency from the model. Set
+  OPENAI_API_KEY before running this command.
+
+  Examples:
+
+      remove-background-ai photo.jpg
+      remove-background-ai photo.jpg -o portrait.png
+      remove-background-ai photo.jpg other.png -d cutouts --json
+      remove-background-ai photo.jpg --keep "the red backpack, including both straps"
+
+Options:
+  -o, --output FILE               Write the PNG to FILE.
+  -d, --output-dir DIRECTORY      Write PNGs to DIRECTORY.
+  --force                         Replace output files that already exist.
+  --keep TEXT                     What to keep, for example the red backpack and its
+                                  straps.
+  --remove TEXT                   What to remove besides the background.
+  --mask FILE                     Mask FILE: white keeps, black removes; same size as
+                                  the image.
+  --mode [original|generated]     Keep original pixels and size, or use the generated
+                                  image.  [default: original]
+  --model [gpt-image-2.5-sunburst-2026-09-08|gpt-image-2.5-sunburst|gpt-image-2.5-flare-2026-09-08|gpt-image-2.5-flare]
+                                  GPT Image model to use.  [default: gpt-
+                                  image-2.5-sunburst-2026-09-08]
+  --quality [low|medium|high|xhigh|max|auto]
+                                  Image edit quality.  [default: high]
+  --json                          Write a JSON array to stdout.
+  --version                       Show the version and exit.
+  --help                          Show this message and exit.
+
+  Exit codes: 0 success; 1 general failure; 2 usage error; 3 input or output refused; 4
+  image edit failed.
+```
+<!-- [[[end]]] -->
+
+## Development
+
+```bash
+git clone https://github.com/nmpowell/remove-background-ai
+cd remove-background-ai
+uv sync --locked
+uv run pytest
+uv run mypy
+uv run ruff check .
+uv run ruff format --check .
+```
+
+The tests run without the API, except one live test that makes a real call and costs one image. It is skipped unless you ask for it:
+
+```bash
+RUN_LIVE_OPENAI_TESTS=1 OPENAI_API_KEY=sk-... uv run pytest -m live
+```
+
+After changing the command's options, regenerate the CLI reference above with `uv run cog -r README.md`. The test suite fails while the reference is out of date.
+
+## Licence
+
+Apache-2.0. See [LICENSE](LICENSE).