withoutbg 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. withoutbg-0.1.0/.gitignore +223 -0
  2. withoutbg-0.1.0/LICENSE +201 -0
  3. withoutbg-0.1.0/PKG-INFO +290 -0
  4. withoutbg-0.1.0/README.md +247 -0
  5. withoutbg-0.1.0/pyproject.toml +172 -0
  6. withoutbg-0.1.0/src/withoutbg/__init__.py +18 -0
  7. withoutbg-0.1.0/src/withoutbg/__version__.py +3 -0
  8. withoutbg-0.1.0/src/withoutbg/api.py +241 -0
  9. withoutbg-0.1.0/src/withoutbg/cli.py +264 -0
  10. withoutbg-0.1.0/src/withoutbg/core.py +109 -0
  11. withoutbg-0.1.0/src/withoutbg/exceptions.py +31 -0
  12. withoutbg-0.1.0/src/withoutbg/models.py +479 -0
  13. withoutbg-0.1.0/src/withoutbg/py.typed +0 -0
  14. withoutbg-0.1.0/tests/__init__.py +0 -0
  15. withoutbg-0.1.0/tests/conftest.py +225 -0
  16. withoutbg-0.1.0/tests/fixtures/__init__.py +5 -0
  17. withoutbg-0.1.0/tests/fixtures/expected_outputs/.gitkeep +2 -0
  18. withoutbg-0.1.0/tests/fixtures/expected_outputs/test-ice-cream.png +0 -0
  19. withoutbg-0.1.0/tests/fixtures/images/.gitkeep +2 -0
  20. withoutbg-0.1.0/tests/fixtures/images/test-ice-cream-api-service-mock-alpha.png +0 -0
  21. withoutbg-0.1.0/tests/fixtures/images/test-ice-cream.png +0 -0
  22. withoutbg-0.1.0/tests/fixtures/mock_responses/.gitkeep +3 -0
  23. withoutbg-0.1.0/tests/fixtures/mock_responses/studio_error_401.json +3 -0
  24. withoutbg-0.1.0/tests/fixtures/mock_responses/studio_error_402.json +3 -0
  25. withoutbg-0.1.0/tests/fixtures/mock_responses/studio_error_429.json +3 -0
  26. withoutbg-0.1.0/tests/fixtures/mock_responses/studio_success.json +3 -0
  27. withoutbg-0.1.0/tests/fixtures/mock_responses/studio_usage_response.json +4 -0
  28. withoutbg-0.1.0/tests/fixtures/mock_responses.py +136 -0
  29. withoutbg-0.1.0/tests/integration/__init__.py +1 -0
  30. withoutbg-0.1.0/tests/integration/test_real_image_processing.py +379 -0
  31. withoutbg-0.1.0/tests/performance/__init__.py +1 -0
  32. withoutbg-0.1.0/tests/performance/test_batch_performance.py +460 -0
  33. withoutbg-0.1.0/tests/performance/test_benchmarks.py +462 -0
  34. withoutbg-0.1.0/tests/performance/test_memory_usage.py +416 -0
  35. withoutbg-0.1.0/tests/test_api.py +357 -0
  36. withoutbg-0.1.0/tests/test_cli.py +727 -0
  37. withoutbg-0.1.0/tests/test_cli_e2e.py +602 -0
@@ -0,0 +1,223 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # poetry
98
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102
+ #poetry.lock
103
+
104
+ # pdm
105
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106
+ #pdm.lock
107
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108
+ # in version control.
109
+ # https://pdm.fming.dev/#use-with-ide
110
+ .pdm.toml
111
+
112
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113
+ __pypackages__/
114
+
115
+ # Celery stuff
116
+ celerybeat-schedule
117
+ celerybeat.pid
118
+
119
+ # SageMath parsed files
120
+ *.sage.py
121
+
122
+ # Environments
123
+ .env
124
+ .venv
125
+ env/
126
+ venv/
127
+ ENV/
128
+ env.bak/
129
+ venv.bak/
130
+
131
+ # Spyder project settings
132
+ .spyderproject
133
+ .spyproject
134
+
135
+ # Rope project settings
136
+ .ropeproject
137
+
138
+ # mkdocs documentation
139
+ /site
140
+
141
+ # mypy
142
+ .mypy_cache/
143
+ .dmypy.json
144
+ dmypy.json
145
+
146
+ # Pyre type checker
147
+ .pyre/
148
+
149
+ # pytype static type analyzer
150
+ .pytype/
151
+
152
+ # Cython debug symbols
153
+ cython_debug/
154
+
155
+ # PyCharm
156
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157
+ # be added to the global gitignore or merged into this project gitignore. For a PyCharm
158
+ # project, it is generally recommended to exclude the project root directory from being
159
+ # committed and only include the relevant parts, such as the source code.
160
+ .idea/
161
+ *.iml
162
+ *.ipr
163
+ *.iws
164
+
165
+ # VS Code
166
+ .vscode/
167
+ !.vscode/settings.json
168
+ !.vscode/tasks.json
169
+ !.vscode/launch.json
170
+ !.vscode/extensions.json
171
+
172
+ # macOS
173
+ .DS_Store
174
+ .AppleDouble
175
+ .LSOverride
176
+ Icon
177
+ ._*
178
+ .DocumentRevisions-V100
179
+ .fseventsd
180
+ .Spotlight-V100
181
+ .TemporaryItems
182
+ .Trashes
183
+ .VolumeIcon.icns
184
+ .com.apple.timemachine.donotpresent
185
+
186
+ # Windows
187
+ Thumbs.db
188
+ Thumbs.db:encryptable
189
+ ehthumbs.db
190
+ ehthumbs_vista.db
191
+ *.tmp
192
+ *.temp
193
+ *.stackdump
194
+ Desktop.ini
195
+ $RECYCLE.BIN/
196
+ *.cab
197
+ *.msi
198
+ *.msix
199
+ *.msm
200
+ *.msp
201
+ *.lnk
202
+
203
+ # Linux
204
+ *~
205
+
206
+ # Project specific
207
+ *.onnx
208
+ *.pt
209
+ *.pth
210
+ bandit-report.json
211
+ test_images/
212
+ output/
213
+ models/
214
+ !src/withoutbg/models/
215
+ llmcontext/
216
+
217
+ # API keys and secrets
218
+ .env.local
219
+ .env.*.local
220
+ api_keys.txt
221
+
222
+ ## Development with LLMs
223
+ CLAUDE.md
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity granting the License.
13
+
14
+ "Legal Entity" shall mean the union of the acting entity and all
15
+ other entities that control, are controlled by, or are under common
16
+ control with that entity. For the purposes of this definition,
17
+ "control" means (i) the power, direct or indirect, to cause the
18
+ direction or management of such entity, whether by contract or
19
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
20
+ outstanding shares, or (iii) beneficial ownership of such entity.
21
+
22
+ "You" (or "Your") shall mean an individual or Legal Entity
23
+ exercising permissions granted by this License.
24
+
25
+ "Source" shall mean the preferred form for making modifications,
26
+ including but not limited to software source code, documentation
27
+ source, and configuration files.
28
+
29
+ "Object" shall mean any form resulting from mechanical
30
+ transformation or translation of a Source form, including but
31
+ not limited to compiled object code, generated documentation,
32
+ and conversions to other media types.
33
+
34
+ "Work" shall mean the work of authorship, whether in Source or
35
+ Object form, made available under the License, as indicated by a
36
+ copyright notice that is included in or attached to the work
37
+ (which shall not include communication that is conspicuously
38
+ marked or otherwise designated in writing by the copyright owner
39
+ as "Not a Contribution").
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based upon (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and derivative works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control
58
+ systems, and issue tracking systems that are managed by, or on behalf
59
+ of, the Licensor for the purpose of discussing and improving the Work,
60
+ but excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution".
62
+
63
+ 2. Grant of Copyright License. Subject to the terms and conditions of
64
+ this License, each Contributor hereby grants to You a perpetual,
65
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
66
+ copyright license to use, reproduce, modify, merge, publish,
67
+ distribute, sublicense, and/or sell copies of the Work, and to
68
+ permit persons to whom the Work is furnished to do so, subject to
69
+ the following conditions:
70
+
71
+ The above copyright notice and this permission notice shall be
72
+ included in all copies or substantial portions of the Work.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright notice to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Support. When redistributing the Work or
167
+ Derivative Works thereof, You may choose to offer, and charge a fee
168
+ for, warranties, support, indemnity, or other liability obligations
169
+ and/or rights consistent with this License. However, in accepting such
170
+ obligations, You may act only on Your own behalf and on Your sole
171
+ responsibility, not on behalf of any other Contributor, and only if
172
+ You agree to indemnify, defend, and hold each Contributor harmless for
173
+ any liability incurred by, or claims asserted against, such Contributor
174
+ by reason of your accepting any such warranty or support.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "page" as the copyright notice for easier identification
187
+ within third-party archives.
188
+
189
+ Copyright 2024 withoutbg
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,290 @@
1
+ Metadata-Version: 2.4
2
+ Name: withoutbg
3
+ Version: 0.1.0
4
+ Summary: AI-powered background removal with local and cloud options
5
+ Project-URL: Homepage, https://withoutbg.com
6
+ Project-URL: Repository, https://github.com/withoutbg/withoutbg
7
+ Project-URL: Documentation, https://withoutbg.com/documentation
8
+ Project-URL: Bug Reports, https://github.com/withoutbg/withoutbg/issues
9
+ Author-email: withoutbg <contact@withoutbg.com>
10
+ License: Apache-2.0
11
+ License-File: LICENSE
12
+ Keywords: ai,background-removal,computer-vision,image-processing,onnx
13
+ Classifier: Development Status :: 4 - Beta
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: License :: OSI Approved :: Apache Software License
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.9
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
22
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
23
+ Requires-Python: >=3.9
24
+ Requires-Dist: click>=8.0.0
25
+ Requires-Dist: huggingface-hub>=0.33.5
26
+ Requires-Dist: numpy>=1.21.0
27
+ Requires-Dist: onnxruntime<1.20.0,>=1.12.0
28
+ Requires-Dist: pillow>=8.0.0
29
+ Requires-Dist: requests>=2.25.0
30
+ Requires-Dist: tqdm>=4.60.0
31
+ Provides-Extra: dev
32
+ Requires-Dist: black>=22.0.0; extra == 'dev'
33
+ Requires-Dist: mypy>=1.0.0; extra == 'dev'
34
+ Requires-Dist: pre-commit>=2.20.0; extra == 'dev'
35
+ Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
36
+ Requires-Dist: pytest>=7.0.0; extra == 'dev'
37
+ Requires-Dist: ruff>=0.1.0; extra == 'dev'
38
+ Requires-Dist: types-pillow>=10.2.0; extra == 'dev'
39
+ Requires-Dist: types-requests>=2.32.0; extra == 'dev'
40
+ Provides-Extra: gpu
41
+ Requires-Dist: onnxruntime-gpu<1.20.0,>=1.12.0; extra == 'gpu'
42
+ Description-Content-Type: text/markdown
43
+
44
+ # withoutbg
45
+
46
+ **AI-powered background removal with local and cloud options**
47
+
48
+ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
49
+ [![CI](https://github.com/withoutbg/withoutbg/actions/workflows/ci.yml/badge.svg)](https://github.com/withoutbg/withoutbg/actions/workflows/ci.yml)
50
+ [![codecov](https://codecov.io/gh/withoutbg/withoutbg/branch/main/graph/badge.svg)](https://codecov.io/gh/withoutbg/withoutbg)
51
+
52
+ Remove backgrounds from images instantly with AI. Choose between local processing (free) or cloud API (best quality).
53
+
54
+ ## 🚀 Quick Start
55
+
56
+ ```bash
57
+ # Install
58
+ pip install withoutbg
59
+
60
+ # Remove background (local processing)
61
+ withoutbg image.jpg
62
+
63
+ # Use cloud API for best quality processing
64
+ withoutbg image.jpg --api-key sk_your_api_key
65
+ ```
66
+
67
+ ## 📦 Model Tiers
68
+
69
+ | Tier | Quality | Usage | License |
70
+ |------|---------|-------|---------|
71
+ | 🟢 **Snap** | Good | Local/Free | Apache 2.0 |
72
+ | 🟡 **Focus** | Better | Commercial | Licensed |
73
+ | 🔴 **Studio** | Best | Cloud API | SaaS credits |
74
+
75
+ ## 💻 Python API
76
+
77
+ ```python
78
+ from withoutbg import remove_background
79
+
80
+ # Local processing with Snap model (free)
81
+ result = remove_background("input.jpg")
82
+ result.save("output.png")
83
+
84
+ # Cloud processing with Studio API (best quality)
85
+ result = remove_background("input.jpg", api_key="sk_your_key")
86
+
87
+ # Batch processing
88
+ from withoutbg import remove_background_batch
89
+ results = remove_background_batch(["img1.jpg", "img2.jpg"],
90
+ output_dir="results/")
91
+ ```
92
+
93
+ ## 🖥️ CLI Usage
94
+
95
+ ### Basic Usage
96
+ ```bash
97
+ # Process single image
98
+ withoutbg photo.jpg
99
+
100
+ # Specify output path
101
+ withoutbg photo.jpg --output result.png
102
+
103
+ # Use different format
104
+ withoutbg photo.jpg --format webp --quality 90
105
+ ```
106
+
107
+ ### Cloud API (Studio)
108
+ ```bash
109
+ # Set API key via environment
110
+ export WITHOUTBG_API_KEY="sk_your_api_key"
111
+ withoutbg photo.jpg --use-api
112
+
113
+ # Or pass directly
114
+ withoutbg photo.jpg --api-key sk_your_key
115
+ ```
116
+
117
+ ### Batch Processing
118
+ ```bash
119
+ # Process all images in directory
120
+ withoutbg photos/ --batch --output-dir results/
121
+
122
+ # With cloud API for best quality
123
+ withoutbg photos/ --batch --use-api --output-dir results/
124
+ ```
125
+
126
+ ## 🔧 Installation Options
127
+
128
+ ### Standard Installation
129
+ ```bash
130
+ pip install withoutbg
131
+ ```
132
+
133
+ ### Development
134
+ ```bash
135
+ git clone https://github.com/withoutbg/withoutbg.git
136
+ cd withoutbg
137
+ pip install -e ".[dev]"
138
+ ```
139
+
140
+ ## 🎨 Examples
141
+
142
+ ### Basic Background Removal
143
+ ```python
144
+ import withoutbg
145
+
146
+ # Simple usage
147
+ output = withoutbg.remove_background("portrait.jpg")
148
+ output.save("portrait-withoutbg.png")
149
+ ```
150
+
151
+ ### E-commerce Product Photos
152
+ ```python
153
+ import withoutbg
154
+ from pathlib import Path
155
+
156
+ # Process product catalog
157
+ product_images = Path("products").glob("*.jpg")
158
+ results = withoutbg.remove_background_batch(
159
+ list(product_images),
160
+ output_dir="catalog-withoutbg/",
161
+ api_key="sk_your_key" # Use Studio for best quality
162
+ )
163
+ ```
164
+
165
+ ### Social Media Automation
166
+ ```python
167
+ import withoutbg
168
+ from PIL import Image
169
+
170
+ # Remove background and add custom background
171
+ foreground = withoutbg.remove_background("selfie.jpg", api_key="sk_key")
172
+ background = Image.open("gradient_bg.jpg")
173
+
174
+ # Composite images
175
+ background.paste(foreground, (0, 0), foreground)
176
+ background.save("social_post.jpg")
177
+ ```
178
+
179
+ ## 🔑 API Key Setup
180
+
181
+ 1. **Get API Key**: Visit [withoutbg.com](https://withoutbg.com) to get your API key
182
+ 2. **Set Environment Variable**:
183
+ ```bash
184
+ export WITHOUTBG_API_KEY="sk_your_api_key"
185
+ ```
186
+ 3. **Or pass directly in code**:
187
+ ```python
188
+ result = withoutbg.remove_background("image.jpg", api_key="sk_your_key")
189
+ ```
190
+
191
+ ## 🏗️ For Developers
192
+
193
+ ### Local Development
194
+ ```bash
195
+ # Clone repository
196
+ git clone https://github.com/withoutbg/withoutbg.git
197
+ cd withoutbg
198
+
199
+ # Install in development mode
200
+ pip install -e ".[dev]"
201
+
202
+ # Run tests
203
+ pytest
204
+
205
+ # Format code
206
+ black src/ tests/
207
+ ruff check src/ tests/
208
+
209
+ # Type checking
210
+ mypy src/
211
+ ```
212
+
213
+ ## 📊 Usage Analytics
214
+
215
+ Track your API usage:
216
+
217
+ ```python
218
+ from withoutbg.api import StudioAPI
219
+
220
+ api = StudioAPI(api_key="sk_your_key")
221
+ usage = api.get_usage()
222
+ print(usage)
223
+ ```
224
+
225
+ ## 🤝 Commercial Licensing
226
+
227
+ ### Focus License
228
+ - ✅ Dockerized model for easy deployment
229
+ - ✅ Multiple runtime options: ONNX, TensorRT, AWS Inferentia
230
+ - ✅ Self-hosted deployment
231
+ - ✅ Better quality than Snap
232
+ - ✅ Priority support
233
+ - ✅ No API dependencies
234
+
235
+ [Get Focus License →](https://withoutbg.com/focus)
236
+
237
+ ### Studio API (Pay-per-use)
238
+ - ✅ Best quality processing
239
+ - ✅ Best quality results
240
+ - ✅ 99.9% uptime SLA
241
+ - ✅ Scalable infrastructure
242
+
243
+ [Try Studio API →](https://withoutbg.com/remove-background)
244
+
245
+ ## 📚 Documentation
246
+
247
+ - **[API Reference](https://withoutbg.com/documentation)** - Complete API documentation
248
+ - **[Model Guide]()** - Choosing the right model
249
+ - **[Integration Examples]()** - Real-world usage patterns
250
+ - **[Quality Benchmarks]()** - Quality metrics and comparisons
251
+
252
+ ## 🐛 Issues & Support
253
+
254
+ - **Bug Reports**: [GitHub Issues](https://github.com/withoutbg/withoutbg/issues)
255
+ - **Feature Requests**: [GitHub Discussions](https://github.com/withoutbg/withoutbg/discussions)
256
+ - **Commercial Support**: [contact@withoutbg.com](mailto:contact@withoutbg.com)
257
+
258
+ ## 🤗 Hugging Face
259
+
260
+ Find our models on Hugging Face:
261
+ - **[withoutbg/snap](https://huggingface.co/withoutbg/snap)** - Open source Snap model
262
+ - **[Demo Widget](https://huggingface.co/spaces/withoutbg/demo)** - Try online
263
+
264
+
265
+ ## 📄 License
266
+
267
+ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
268
+
269
+ ### Third-Party Components
270
+ - **Depth Anything**: Apache 2.0 License
271
+
272
+ See [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md) for complete attribution.
273
+
274
+ ## 🌟 Contributing
275
+
276
+ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
277
+
278
+ 1. Fork the repository
279
+ 2. Create a feature branch
280
+ 3. Make your changes
281
+ 4. Add tests
282
+ 5. Submit a pull request
283
+
284
+ ## 📈 Star History
285
+
286
+ [![Star History Chart](https://api.star-history.com/svg?repos=withoutbg/withoutbg&type=Date)](https://star-history.com/#withoutbg/withoutbg&Date)
287
+
288
+ ---
289
+
290
+ **[🎯 Get best quality results with withoutbg.com](https://withoutbg.com)**