Repository navigation
Expand file tree
/
Copy path_generate_docs.py
More file actions
1925 lines (1655 loc) · 83.3 KB
/
Copy path_generate_docs.py
File metadata and controls
1925 lines (1655 loc) · 83.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
"""One-shot authoring helper: emit docs HTML pages with shared chrome."""
from pathlib import Path
ROOT = Path(__file__).resolve().parent
HEAD = """<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>{title}</title>
<meta name="description" content="{description}">
<meta name="robots" content="index, follow">
<meta name="theme-color" content="#050510">
<meta name="color-scheme" content="dark">
<link rel="canonical" href="https://uploadkit.github.io{canonical}">
<meta property="og:type" content="website">
<meta property="og:site_name" content="UploadKit">
<meta property="og:title" content="{title}">
<meta property="og:description" content="{description}">
<meta property="og:url" content="https://uploadkit.github.io{canonical}">
<meta property="og:image" content="https://uploadkit.github.io/uploadkit-Fav.png">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@500;600;700&family=IBM+Plex+Mono:wght@400;500&family=Inter:wght@400;500;600&display=swap" rel="stylesheet">
<link rel="stylesheet" href="/styles.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism-tomorrow.min.css">
<link href="/pagefind/pagefind-ui.css" rel="stylesheet">
<link rel="icon" type="image/png" href="/uploadkit-Fav.png">
<link rel="apple-touch-icon" href="/uploadkit-Fav.png">
</head>
<body class="docs-page">
<div class="grid-bg"></div>
<div class="orb orb-1"></div>
<div class="orb orb-2"></div>
<div class="orb orb-3"></div>
<header class="site-header">
<a class="brand" href="/">UploadKit</a>
<nav class="nav-links" aria-label="Primary">
<a href="/#packages">Packages</a>
<a href="/docs/">Docs</a>
<a href="https://github.com/uploadkit" target="_blank" rel="noopener">GitHub</a>
</nav>
<button type="button" class="mobile-menu-btn" id="mobile-menu-btn" aria-label="Menu">☰</button>
</header>
<button type="button" class="docs-sidebar-toggle" id="docs-sidebar-toggle" aria-expanded="false" aria-controls="docs-sidebar">Menu</button>
<div class="docs-sidebar-backdrop" id="docs-sidebar-backdrop"></div>
<div class="docs-layout">
<aside class="docs-sidebar" id="docs-sidebar" aria-label="Docs">
<div class="docs-search" id="docs-search"></div>
<div class="docs-nav-group">
<p class="docs-nav-label">Start</p>
<ul class="docs-nav">
<li><a href="/docs/"{active_getting}>Getting started</a></li>
<li><a href="/docs/cli/"{active_cli}>CLI</a></li>
</ul>
</div>
<div class="docs-nav-group">
<p class="docs-nav-label">Reference</p>
<ul class="docs-nav">
<li><a href="/docs/core/"{active_core}><span class="docs-nav-link-inner"><span class="tab-icon tab-icon--python" aria-hidden="true"></span>Core</span></a></li>
<li><a href="/docs/patterns/"{active_patterns}>Common patterns</a></li>
<li><a href="/docs/storage/"{active_storage}>Storage</a></li>
<li><a href="/docs/performance/"{active_performance}>Performance</a></li>
<li><a href="/docs/security/"{active_security}>Security</a></li>
</ul>
</div>
<div class="docs-nav-group">
<p class="docs-nav-label">Features</p>
<ul class="docs-nav">
<li><a href="/docs/pdf/"{active_pdf}>PDF</a></li>
<li><a href="/docs/office/"{active_office}>Office</a></li>
<li><a href="/docs/audio/"{active_audio}>Audio</a></li>
</ul>
</div>
<div class="docs-nav-group">
<p class="docs-nav-label">Frameworks</p>
<ul class="docs-nav">
<li><a href="/docs/django/"{active_django}><span class="docs-nav-link-inner"><span class="tab-icon tab-icon--django" aria-hidden="true"></span>Django</span> <span class="badge badge-live">Supported</span></a></li>
<li><a href="/docs/fastapi/"{active_fastapi}><span class="docs-nav-link-inner"><span class="tab-icon tab-icon--fastapi" aria-hidden="true"></span>FastAPI</span> <span class="badge badge-live">Supported</span></a></li>
<li><a href="/docs/aiohttp/"{active_aiohttp}><span class="docs-nav-link-inner"><span class="tab-icon tab-icon--aiohttp" aria-hidden="true"></span>aiohttp</span> <span class="badge badge-live">Supported</span></a></li>
<li><a href="/docs/odoo/"{active_odoo}><span class="docs-nav-link-inner"><span class="tab-icon tab-icon--odoo" aria-hidden="true"></span>Odoo</span> <span class="badge badge-live">Supported</span></a></li>
<li><a href="/docs/flask/"{active_flask}><span class="docs-nav-link-inner"><span class="tab-icon tab-icon--flask" aria-hidden="true"></span>Flask</span> <span class="badge badge-live">Supported</span></a></li>
</ul>
</div>
</aside>
<main class="docs-main docs-content">
<article class="docs-prose" data-pagefind-body>
{content}
</article>
</main>
</div>
<footer class="site-footer">
<span>Built for Python developers</span>
<span class="footer-sep">·</span>
<a href="https://github.com/uploadkit" target="_blank" rel="noopener">github.com/uploadkit</a>
</footer>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-core.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-clike.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-python.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-bash.min.js"></script>
<script src="/pagefind/pagefind-ui.js"></script>
<script src="/script.js"></script>
</body>
</html>
"""
ACTIVE_KEYS = (
"getting",
"cli",
"core",
"patterns",
"storage",
"performance",
"security",
"pdf",
"office",
"audio",
"django",
"fastapi",
"aiohttp",
"odoo",
"flask",
)
def active_attrs(current: str) -> dict[str, str]:
return {
f"active_{k}": ' class="active" aria-current="page"' if k == current else ""
for k in ACTIVE_KEYS
}
def write_page(rel: str, *, title: str, description: str, canonical: str, current: str, content: str) -> None:
path = ROOT / rel
path.parent.mkdir(parents=True, exist_ok=True)
html = HEAD.format(
title=title,
description=description,
canonical=canonical,
content=content,
**active_attrs(current),
)
path.write_text(html, encoding="utf-8")
print(f"wrote {path.relative_to(ROOT)}")
def code_block(filename: str, lang: str, code: str, *, console: bool = False) -> str:
cls = "code-block code-block--console" if console else "code-block"
escaped = (
code.replace("&", "&")
.replace("<", "<")
.replace(">", ">")
)
return f""" <figure class="{cls}">
<figcaption class="code-block-caption">
<code>{filename}</code>
<button type="button" class="copy-btn" aria-label="Copy">Copy</button>
</figcaption>
<div class="code-block-body">
<pre><code class="language-{lang}">{escaped}</code></pre>
</div>
</figure>"""
def docs_table(
headers: list[str],
rows: list[list[str]],
*,
caption: str | None = None,
variant: str = "",
) -> str:
"""Build a semantic HTML data table for docs prose."""
cls = "docs-table"
if variant:
cls = f"{cls} docs-table--{variant}"
head_cells = "".join(f"<th scope=\"col\">{h}</th>" for h in headers)
body_rows = []
for row in rows:
cells = "".join(f"<td>{c}</td>" for c in row)
body_rows.append(f" <tr>{cells}</tr>")
caption_html = f"\n <caption>{caption}</caption>" if caption else ""
return f""" <div class="table-wrap">
<table class="{cls}">{caption_html}
<thead>
<tr>{head_cells}</tr>
</thead>
<tbody>
{chr(10).join(body_rows)}
</tbody>
</table>
</div>"""
def install_tabs(prefix: str, pip: str, uv: str, poetry: str) -> str:
return f""" <div class="tabs nested-tabs install-tabs" data-tabs="install-{prefix}">
<div class="tab-bar" role="tablist" aria-label="Install with">
<button type="button" class="tab-btn active" data-tab="install-{prefix}-pip" role="tab" aria-selected="true">pip</button>
<button type="button" class="tab-btn" data-tab="install-{prefix}-uv" role="tab" aria-selected="false">uv</button>
<button type="button" class="tab-btn" data-tab="install-{prefix}-poetry" role="tab" aria-selected="false">poetry</button>
</div>
<div id="install-{prefix}-pip" class="tab-panel active" role="tabpanel">
{code_block("Shell", "bash", pip, console=True)}
</div>
<div id="install-{prefix}-uv" class="tab-panel" role="tabpanel">
{code_block("Shell", "bash", uv, console=True)}
</div>
<div id="install-{prefix}-poetry" class="tab-panel" role="tabpanel">
{code_block("Shell", "bash", poetry, console=True)}
</div>
</div>"""
# --- Content ---
GETTING = f"""
<h1>Getting started</h1>
<p class="section-lead">UploadKit is a modular, framework-independent upload pipeline for Python. Install Core, add security validators, then wire a framework adapter (or use Core directly).</p>
<h2>Install Core</h2>
{install_tabs(
"getting",
"pip install uploadkit uploadkit-security\n# optional storage SDKs (not package deps):\n# pip install boto3 aioboto3",
"uv add uploadkit uploadkit-security",
"poetry add uploadkit uploadkit-security",
)}
<h2>Next steps</h2>
<ul>
<li><a href="/docs/core/">Core reference</a> — sync <code>Uploader</code> and async <code>AsyncUploader</code></li>
<li><a href="/docs/storage/">Storage</a> — boto3 / aioboto3 for AWS S3 and MinIO</li>
<li><a href="/docs/performance/">Performance</a> — chunk size, S3 part size, and workers by file size</li>
<li><a href="/docs/patterns/">Common patterns</a> — policy, validators, errors, JSON shape</li>
<li><a href="/docs/django/">Django</a>, <a href="/docs/fastapi/">FastAPI</a>, <a href="/docs/aiohttp/">aiohttp</a>, or <a href="/docs/odoo/">Odoo</a> — adapter glue</li>
<li><a href="/docs/security/">Security</a> — <code>uploadkit-security</code> and libmagic</li>
<li>Feature packages —
<a href="/docs/pdf/">PDF</a>,
<a href="/docs/office/">Office</a>,
<a href="/docs/audio/">Audio</a>
</li>
<li><a href="/docs/cli/">CLI</a> — validate, inspect, and simulate uploads locally</li>
</ul>
"""
CORE_SYNC = """import boto3
from botocore.client import Config
from uploadkit import Uploader, UploadPolicy
from uploadkit_security import default_validators
class Boto3S3Storage:
def __init__(self, *, access_key, secret_key, region="us-east-1", endpoint_url=None):
kwargs = dict(
service_name="s3",
aws_access_key_id=access_key,
aws_secret_access_key=secret_key,
region_name=region,
config=Config(signature_version="s3v4"),
)
if endpoint_url:
kwargs["endpoint_url"] = endpoint_url
self.client = boto3.client(**kwargs)
def put(self, *, bucket, object_name, body, content_type):
resp = self.client.put_object(
Bucket=bucket, Key=object_name, Body=body, ContentType=content_type,
)
return resp.get("ETag")
# AWS S3
storage = Boto3S3Storage(access_key="AKIA...", secret_key="...", region="eu-west-1")
# MinIO
storage = Boto3S3Storage(
endpoint_url="http://127.0.0.1:9000",
access_key="minioadmin",
secret_key="minioadmin",
)
# Policy + validators: see Common patterns
policy = UploadPolicy(
max_size=10 * 1024 * 1024,
allowed_extensions=frozenset({"png", "jpg"}),
allowed_mime_types=frozenset({"image/png", "image/jpeg"}),
validators=default_validators(),
)
def notify(result):
...
result = Uploader(policy, storage).upload(
file,
bucket="uploads",
object_name="2026/file.png",
after_upload=notify, # or Celery-like .delay
)"""
CORE_ASYNC = """from uploadkit import AsyncUploader, UploadPolicy
from uploadkit_security import default_async_validators
# from myapp.s3_async import AsyncS3Storage # see /docs/storage/
# AWS S3
async_storage = AsyncS3Storage(
access_key="AKIA...", secret_key="...", region="eu-west-1",
)
# MinIO
async_storage = AsyncS3Storage(
endpoint_url="http://127.0.0.1:9000",
access_key="minioadmin",
secret_key="minioadmin",
)
policy = UploadPolicy(
max_size=10 * 1024 * 1024,
allowed_extensions=frozenset({"png", "jpg"}),
allowed_mime_types=frozenset({"image/png", "image/jpeg"}),
async_validators=default_async_validators(),
)
async def notify(result):
...
result = await AsyncUploader(policy, async_storage).upload(
source, # AsyncByteSource
bucket="uploads",
object_name="2026/file.png",
after_upload=notify, # sync, async, or Celery-like .delay
)"""
CORE_AFTER_UPLOAD = """def notify(result):
...
# Sync callback
Uploader(policy, storage).upload(
file, bucket="uploads", object_name="a.png", after_upload=notify,
)
# Celery-like — Core calls task.delay(**result.as_task_kwargs())
Uploader(policy, storage).upload(
file, bucket="uploads", object_name="a.png", after_upload=process_upload,
)
# AsyncUploader — sync or async callback (awaited), or .delay
await AsyncUploader(policy, async_storage).upload(
source, bucket="uploads", object_name="a.png", after_upload=notify,
)"""
CORE = f"""
<h1>Core</h1>
<p class="section-lead">Framework-free orchestration. Choose sync <code>Uploader</code> or async streaming <code>AsyncUploader</code> — then plug any framework adapter.</p>
<h2>Install</h2>
{install_tabs(
"core",
"pip install uploadkit uploadkit-security\n# optional storage SDKs (not package deps):\n# pip install boto3 aioboto3",
"uv add uploadkit uploadkit-security",
"poetry add uploadkit uploadkit-security",
)}
<h2>Examples</h2>
<p class="section-note">Shared <code>UploadPolicy</code>, validators, after-upload hooks, and error handling are documented in <a href="/docs/patterns/">Common patterns</a>.</p>
<div class="tabs nested-tabs" data-tabs="core-inner">
<div class="tab-bar" role="tablist" aria-label="Core examples">
<button type="button" class="tab-btn active" data-tab="tab-core-sync" role="tab" aria-selected="true">Sync</button>
<button type="button" class="tab-btn" data-tab="tab-core-async" role="tab" aria-selected="false">Async</button>
</div>
<div id="tab-core-sync" class="tab-panel active" role="tabpanel">
<p class="section-note"><code>Boto3S3Storage</code> works for <strong>AWS S3</strong> and <strong>MinIO</strong>. Full classes and install notes: <a href="/docs/storage/">Storage</a>.</p>
{code_block("storage_sync.py", "python", CORE_SYNC)}
</div>
<div id="tab-core-async" class="tab-panel" role="tabpanel">
<p class="section-note"><code>AsyncS3Storage</code> (aioboto3 multipart) — same AWS vs MinIO wiring. Full writer class: <a href="/docs/storage/">Storage</a>. Tune <code>chunk_size</code> and multipart part size in <a href="/docs/performance/">Performance</a>.</p>
{code_block("example_async.py", "python", CORE_ASYNC)}
</div>
</div>
<h2>After-upload hooks</h2>
<p>Optional <code>after_upload</code> on <code>Uploader.upload</code> / <code>AsyncUploader.upload</code> runs <strong>once</strong> after a successful store, before returning <code>UploadResult</code>. It does not run on validation or storage failure. Hook exceptions <strong>propagate</strong>.</p>
<p class="section-note">Shapes: sync callback, async callback (<code>AsyncUploader</code> awaits), or Celery-like <code>.delay(**result.as_task_kwargs())</code>. Full shared write-up: <a href="/docs/patterns/">Common patterns</a>.</p>
{code_block("after_upload.py", "python", CORE_AFTER_UPLOAD)}
<p class="section-note">
Storage providers:
<a href="/docs/storage/">Storage</a>
·
Tuning:
<a href="/docs/performance/">Performance</a>
·
Docs:
<a href="https://github.com/uploadkit/uploadkit" target="_blank" rel="noopener">uploadkit</a>
·
<a href="https://github.com/uploadkit/uploadkit-security" target="_blank" rel="noopener">uploadkit-security</a>
</p>
"""
DJANGO_VIEW = """from django.conf import settings
from django.http import JsonResponse
from uploadkit import Uploader, UploadPolicy, UploaderError
from uploadkit_django import as_uploadable, get_storage_provider, json_error_response
from uploadkit_security import default_validators
def notify(result):
...
def upload_view(request):
storage = get_storage_provider()
policy = UploadPolicy(
max_size=5 * 1024 * 1024,
allowed_extensions=frozenset({"png"}),
allowed_mime_types=frozenset({"image/png"}),
validators=default_validators(),
)
uploaded = request.FILES["file"]
try:
result = Uploader(policy, storage).upload(
as_uploadable(uploaded),
bucket=settings.UPLOADKIT_BUCKET,
object_name=uploaded.name,
after_upload=notify, # or Celery-like .delay
)
except UploaderError as exc:
return json_error_response(exc)
return JsonResponse({
"object_name": result.object_name,
"sha256": result.sha256,
"etag": result.etag,
})"""
DJANGO_SETTINGS = """# settings.py — AWS S3
AWS_ACCESS_KEY_ID = "AKIA..."
AWS_SECRET_ACCESS_KEY = "..."
AWS_S3_REGION_NAME = "eu-west-1"
UPLOADKIT_STORAGE_PROVIDER = "myapp.storage.get_provider"
UPLOADKIT_BUCKET = "my-prod-bucket"
# settings.py — MinIO (instead of / in addition to keys)
# AWS_S3_ENDPOINT_URL = "http://127.0.0.1:9000"
# AWS_ACCESS_KEY_ID = "minioadmin"
# AWS_SECRET_ACCESS_KEY = "minioadmin"
# myapp/storage.py — Boto3S3Storage + get_provider()
# (full class in /docs/storage/)
def get_provider():
from django.conf import settings
return Boto3S3Storage(
access_key=settings.AWS_ACCESS_KEY_ID,
secret_key=settings.AWS_SECRET_ACCESS_KEY,
region=getattr(settings, "AWS_S3_REGION_NAME", "us-east-1"),
endpoint_url=getattr(settings, "AWS_S3_ENDPOINT_URL", None),
)"""
DJANGO = f"""
<h1>Django</h1>
<p class="section-lead">Thin integration over Core. Pair with <code>uploadkit-security</code> for the default validator stack. Python 3.10–3.13, Django 4.2+.</p>
<h2>Install</h2>
{install_tabs(
"django",
"pip install uploadkit-django uploadkit-security",
"uv add uploadkit-django uploadkit-security",
"poetry add uploadkit-django uploadkit-security",
)}
<h2>Adapter glue</h2>
<p class="section-note">Policy setup, validators, <code>UploaderError</code>, and the JSON response shape are shared — see <a href="/docs/patterns/">Common patterns</a>.</p>
<div class="tabs nested-tabs" data-tabs="django-inner">
<div class="tab-bar" role="tablist" aria-label="Django examples">
<button type="button" class="tab-btn active" data-tab="tab-view" role="tab" aria-selected="true">View</button>
<button type="button" class="tab-btn" data-tab="tab-settings" role="tab" aria-selected="false">Settings</button>
</div>
<div id="tab-view" class="tab-panel active" role="tabpanel">
<p class="section-note">Uses <code>get_storage_provider()</code> → <code>Boto3S3Storage</code> (AWS S3 or MinIO) and <code>as_uploadable()</code>.</p>
{code_block("views.py", "python", DJANGO_VIEW)}
</div>
<div id="tab-settings" class="tab-panel" role="tabpanel">
<p class="section-note">AWS: leave <code>AWS_S3_ENDPOINT_URL</code> unset. MinIO: set it to your endpoint.</p>
{code_block("settings.py + storage.py", "python", DJANGO_SETTINGS)}
</div>
</div>
<p class="section-note">
After-upload hooks: <a href="/docs/patterns/">Common patterns</a>
·
Full <code>Boto3S3Storage</code> class:
<a href="/docs/storage/">Storage</a>
·
<a href="https://github.com/uploadkit/uploadkit-django" target="_blank" rel="noopener">uploadkit-django README</a>
</p>
"""
FASTAPI_ASYNC = """from fastapi import BackgroundTasks, FastAPI, UploadFile
from uploadkit import AsyncUploader, UploadPolicy, UploaderError
from uploadkit_fastapi import (
as_async_source,
background_after_upload,
json_error_response,
)
from uploadkit_security import default_async_validators
app = FastAPI()
# AWS:
# async_storage = AsyncS3Storage(access_key="AKIA...", secret_key="...", region="eu-west-1")
# MinIO:
async_storage = AsyncS3Storage(
endpoint_url="http://127.0.0.1:9000",
access_key="minioadmin",
secret_key="minioadmin",
)
@app.post("/upload")
async def upload(file: UploadFile, background_tasks: BackgroundTasks):
policy = UploadPolicy(
max_size=5 * 1024 * 1024,
allowed_extensions=frozenset({"png"}),
allowed_mime_types=frozenset({"image/png"}),
async_validators=default_async_validators(),
)
try:
result = await AsyncUploader(policy, async_storage).upload(
as_async_source(file),
bucket="uploads",
object_name=file.filename or "object",
after_upload=background_after_upload(background_tasks, notify),
)
except UploaderError as exc:
return json_error_response(exc)
return {
"object_name": result.object_name,
"sha256": result.sha256,
"etag": result.etag,
}"""
FASTAPI_SYNC = """from fastapi import BackgroundTasks, FastAPI, UploadFile
from uploadkit import Uploader, UploadPolicy, UploaderError
from uploadkit_fastapi import (
as_uploadable,
background_after_upload,
json_error_response,
run_sync_upload,
)
from uploadkit_security import default_validators
app = FastAPI()
# AWS: Boto3S3Storage(access_key="AKIA...", secret_key="...", region="eu-west-1")
boto3_storage = Boto3S3Storage(
endpoint_url="http://127.0.0.1:9000",
access_key="minioadmin",
secret_key="minioadmin",
)
@app.post("/upload-sync")
async def upload_sync(file: UploadFile, background_tasks: BackgroundTasks):
policy = UploadPolicy(
max_size=5 * 1024 * 1024,
allowed_extensions=frozenset({"png"}),
allowed_mime_types=frozenset({"image/png"}),
validators=default_validators(),
)
try:
result = await run_sync_upload(
Uploader(policy, boto3_storage),
as_uploadable(file),
bucket="uploads",
object_name=file.filename or "object",
after_upload=background_after_upload(background_tasks, notify),
)
except UploaderError as exc:
return json_error_response(exc)
return {
"object_name": result.object_name,
"sha256": result.sha256,
"etag": result.etag,
}"""
FASTAPI = f"""
<h1>FastAPI</h1>
<p class="section-lead">Thin FastAPI adapters over Core. Choose <strong>async streaming</strong> (<code>AsyncS3Storage</code> / aioboto3) or <strong>sync</strong> (<code>Boto3S3Storage</code> / boto3). Pair with <code>uploadkit-security</code>.</p>
<h2>Install</h2>
{install_tabs(
"fastapi",
"pip install uploadkit-fastapi uploadkit-security",
"uv add uploadkit-fastapi uploadkit-security",
"poetry add uploadkit-fastapi uploadkit-security",
)}
<h2>Adapter glue</h2>
<p class="section-note">Shared policy, validators, errors, and JSON shape: <a href="/docs/patterns/">Common patterns</a>.</p>
<div class="tabs nested-tabs" data-tabs="fastapi-inner">
<div class="tab-bar" role="tablist" aria-label="FastAPI examples">
<button type="button" class="tab-btn active" data-tab="tab-fastapi-async" role="tab" aria-selected="true">Async</button>
<button type="button" class="tab-btn" data-tab="tab-fastapi-sync" role="tab" aria-selected="false">Sync</button>
</div>
<div id="tab-fastapi-async" class="tab-panel active" role="tabpanel">
<p class="section-note">Copy <code>AsyncS3Storage</code> from <a href="/docs/storage/">Storage</a>. Requires <code>pip install aioboto3</code>. Uses <code>as_async_source()</code> and <code>background_after_upload()</code>.</p>
{code_block("main.py", "python", FASTAPI_ASYNC)}
</div>
<div id="tab-fastapi-sync" class="tab-panel" role="tabpanel">
<p class="section-note"><code>Boto3S3Storage</code> + <code>run_sync_upload</code>. Requires <code>pip install boto3</code>. Full class: <a href="/docs/storage/">Storage</a>.</p>
{code_block("main.py", "python", FASTAPI_SYNC)}
</div>
</div>
<h2>After-upload options</h2>
<p>Pass Core <code>after_upload</code> on <code>Uploader.upload</code> / <code>AsyncUploader.upload</code>. The hook runs once after a successful put.</p>
<ol>
<li><strong>BackgroundTasks</strong> — <code>background_after_upload(background_tasks, notify)</code> schedules work after the response is sent.</li>
<li><strong>Celery-like</strong> — object with <code>.delay(**kwargs)</code>; Core calls <code>delay(**result.as_task_kwargs())</code>.</li>
<li><strong>Plain callback</strong> — sync <code>(result) -> None</code>, or <code>async def</code> on the async stack (awaited). Exceptions propagate and fail the request.</li>
</ol>
<p class="section-note">
Shared semantics: <a href="/docs/patterns/">Common patterns</a>
·
Full storage classes:
<a href="/docs/storage/">Storage</a>
·
<a href="https://github.com/uploadkit/uploadkit-fastapi" target="_blank" rel="noopener">uploadkit-fastapi</a>
</p>
"""
AIOHTTP_ADAPTER = """import aiohttp
from aiohttp.multipart import BodyPartReader
class AiohttpByteSource:
\"\"\"Adapt an aiohttp multipart part for AsyncUploader.\"\"\"
def __init__(self, part: BodyPartReader) -> None:
self._part = part
self.name = part.filename
self.size = None # often unknown until fully read
self.content_type = part.headers.get(
aiohttp.hdrs.CONTENT_TYPE,
"application/octet-stream",
)
async def read(self, size: int = -1) -> bytes:
if size < 0:
return await self._part.read(decode=False)
chunk = await self._part.read_chunk(size)
return chunk or b\"\""""
AIOHTTP_HANDLER = """from aiohttp import web
from uploadkit import AsyncUploader, UploadPolicy, UploaderError
from uploadkit_security import default_async_validators
from adapters import AiohttpByteSource
async def upload_handler(request: web.Request) -> web.Response:
reader = await request.multipart()
part = await reader.next()
while part is not None:
if part.name == "file" and part.filename:
break
part = await reader.next()
if part is None or not part.filename:
return web.json_response(
{"error": "MissingFile", "message": "file field required"},
status=400,
)
policy = UploadPolicy(
max_size=5 * 1024 * 1024,
allowed_extensions=frozenset({"png"}),
allowed_mime_types=frozenset({"image/png"}),
async_validators=default_async_validators(),
)
try:
result = await AsyncUploader(policy, request.app["async_storage"]).upload(
AiohttpByteSource(part),
bucket="uploads",
object_name=part.filename,
after_upload=notify, # sync callback, async callback, or Celery-like .delay
)
except UploaderError as exc:
return web.json_response(
{"error": type(exc).__name__, "message": str(exc)},
status=400,
)
return web.json_response({
"object_name": result.object_name,
"sha256": result.sha256,
"etag": result.etag,
})"""
AIOHTTP_APP = """from aiohttp import web
from handlers import upload_handler
# from myapp.s3_async import AsyncS3Storage # see /docs/storage/
async def notify(result) -> None:
# Or pass a sync def, or a Celery-like task with .delay
...
# AWS:
# async_storage = AsyncS3Storage(access_key="AKIA...", secret_key="...", region="eu-west-1")
# MinIO:
async_storage = AsyncS3Storage(
endpoint_url="http://127.0.0.1:9000",
access_key="minioadmin",
secret_key="minioadmin",
)
app = web.Application()
app["async_storage"] = async_storage
app.router.add_post("/upload", upload_handler)
if __name__ == "__main__":
web.run_app(app, host="0.0.0.0", port=8080)"""
AIOHTTP = f"""
<h1>aiohttp</h1>
<p class="section-lead">No dedicated integration package — use Core directly. Wrap aiohttp multipart parts as <code>AsyncByteSource</code> and call <code>AsyncUploader</code>. Pair with <code>uploadkit-security</code>.</p>
<h2>Install</h2>
{install_tabs(
"aiohttp",
"pip install uploadkit uploadkit-security aiohttp",
"uv add uploadkit uploadkit-security aiohttp",
"poetry add uploadkit uploadkit-security aiohttp",
)}
<h2>Adapter glue</h2>
<p class="section-note">Shared policy and error conventions: <a href="/docs/patterns/">Common patterns</a>. Here the unique piece is the multipart <code>AsyncByteSource</code>.</p>
<div class="tabs nested-tabs" data-tabs="aiohttp-inner">
<div class="tab-bar" role="tablist" aria-label="aiohttp examples">
<button type="button" class="tab-btn active" data-tab="tab-aiohttp-adapter" role="tab" aria-selected="true">Adapter</button>
<button type="button" class="tab-btn" data-tab="tab-aiohttp-handler" role="tab" aria-selected="false">Handler</button>
<button type="button" class="tab-btn" data-tab="tab-aiohttp-app" role="tab" aria-selected="false">App</button>
</div>
<div id="tab-aiohttp-adapter" class="tab-panel active" role="tabpanel">
<p class="section-note">Thin <code>AsyncByteSource</code> over aiohttp’s multipart body part (<code>BodyPartReader</code>).</p>
{code_block("adapters.py", "python", AIOHTTP_ADAPTER)}
</div>
<div id="tab-aiohttp-handler" class="tab-panel" role="tabpanel">
<p class="section-note">Parse multipart, find the file field, stream through <code>AsyncUploader</code>.</p>
{code_block("handlers.py", "python", AIOHTTP_HANDLER)}
</div>
<div id="tab-aiohttp-app" class="tab-panel" role="tabpanel">
<p class="section-note">Use <code>AsyncS3Storage</code> from <a href="/docs/storage/">Storage</a> for AWS S3 or MinIO.</p>
{code_block("app.py", "python", AIOHTTP_APP)}
</div>
</div>
<p class="section-note">
Same Core async stack as FastAPI — only the <code>AsyncByteSource</code> adapter differs.
After-upload: <a href="/docs/patterns/">Common patterns</a>
·
Storage:
<a href="/docs/storage/">Storage</a>
·
Docs:
<a href="https://github.com/uploadkit/uploadkit" target="_blank" rel="noopener">uploadkit</a>
</p>
"""
ODOO_CONTROLLER = """from odoo import http
from odoo.http import request
from uploadkit import Uploader, UploadPolicy, UploaderError
from uploadkit_odoo import as_uploadable, json_error_response
from uploadkit_security import default_validators
def notify(result):
...
class MyController(http.Controller):
@http.route("/my/upload", type="http", auth="user", methods=["POST"], csrf=True)
def upload(self, **kw):
storage = get_provider() # your StorageProvider factory
policy = UploadPolicy(
max_size=5 * 1024 * 1024,
allowed_extensions=frozenset({"png"}),
allowed_mime_types=frozenset({"image/png"}),
validators=default_validators(),
)
uploaded = kw.get("file")
try:
result = Uploader(policy, storage).upload(
as_uploadable(uploaded),
bucket="uploads",
object_name=uploaded.filename,
after_upload=notify, # or Celery-like .delay
)
except UploaderError as exc:
return json_error_response(exc)
return request.make_json_response(result.as_task_kwargs())"""
ODOO_STORAGE = """# my_module/storage.py
import boto3
from botocore.client import Config
from odoo.tools import config
class Boto3S3Storage:
def __init__(
self,
*,
access_key: str,
secret_key: str,
region: str = "us-east-1",
endpoint_url: str | None = None,
) -> None:
kwargs: dict = {
"service_name": "s3",
"aws_access_key_id": access_key,
"aws_secret_access_key": secret_key,
"region_name": region,
"config": Config(signature_version="s3v4"),
}
if endpoint_url:
kwargs["endpoint_url"] = endpoint_url
self.client = boto3.client(**kwargs)
def put(self, *, bucket, object_name, body, content_type):
resp = self.client.put_object(
Bucket=bucket,
Key=object_name,
Body=body,
ContentType=content_type,
)
return resp.get("ETag")
def get_provider():
\"\"\"Factory used by uploadkit.storage_provider config parameter.\"\"\"
return Boto3S3Storage(
access_key=config.get("uploadkit_access_key", ""),
secret_key=config.get("uploadkit_secret_key", ""),
region=config.get("uploadkit_region", "us-east-1"),
endpoint_url=config.get("uploadkit_endpoint_url") or None,
)"""
ODOO_SERVICE = """# After installing the UploadKit Odoo addon:
result = env["uploadkit.service"].upload(
file_storage,
object_name="docs/a.pdf",
)
# result is UploadResult.as_task_kwargs() — no after_upload parameter
# Enqueue from the dict, or call Uploader.upload(..., after_upload=...) yourself
# Or POST multipart to /uploadkit/upload (auth=user, CSRF)
# field: file | optional: object_name"""
ODOO = f"""
<h1>Odoo</h1>
<p class="section-lead">Thin integration over Core. Adapts Werkzeug <code>FileStorage</code> from Odoo controllers and maps errors to JSON. Optional Odoo 17/18 addon wires settings, a service model, and an HTTP route. Python 3.10–3.12.</p>
<h2>Install</h2>
{install_tabs(
"odoo",
"pip install uploadkit-odoo uploadkit-security",
"uv add uploadkit-odoo uploadkit-security",
"poetry add uploadkit-odoo uploadkit-security",
)}
<h2>Adapter glue</h2>
<p class="section-note">Policy setup, validators, <code>UploaderError</code>, and the JSON response shape are shared — see <a href="/docs/patterns/">Common patterns</a>. Supply your own <code>StorageProvider</code>; creating <code>ir.attachment</code> records after upload is left to your module.</p>
<div class="tabs nested-tabs" data-tabs="odoo-inner">
<div class="tab-bar" role="tablist" aria-label="Odoo examples">
<button type="button" class="tab-btn active" data-tab="tab-odoo-controller" role="tab" aria-selected="true">Controller</button>
<button type="button" class="tab-btn" data-tab="tab-odoo-storage" role="tab" aria-selected="false">Storage</button>
<button type="button" class="tab-btn" data-tab="tab-odoo-addon" role="tab" aria-selected="false">Addon</button>
</div>
<div id="tab-odoo-controller" class="tab-panel active" role="tabpanel">
<p class="section-note">Uses <code>as_uploadable()</code> on Werkzeug <code>FileStorage</code> and <code>json_error_response()</code>.</p>
{code_block("controllers.py", "python", ODOO_CONTROLLER)}
</div>
<div id="tab-odoo-storage" class="tab-panel" role="tabpanel">
<p class="section-note">AWS: leave <code>endpoint_url</code> unset. MinIO: set it to your endpoint. Full class also in <a href="/docs/storage/">Storage</a>.</p>
{code_block("storage.py", "python", ODOO_STORAGE)}
</div>
<div id="tab-odoo-addon" class="tab-panel" role="tabpanel">
<p class="section-note">Add this repo’s <code>addons/</code> to Odoo <code>addons_path</code>, install <strong>UploadKit</strong> in Apps, then configure under <strong>Settings → UploadKit</strong> (storage factory, bucket, optional prefix / max size).</p>
{code_block("service.py", "python", ODOO_SERVICE)}
</div>
</div>
<p class="section-note">
After-upload on library controllers: <a href="/docs/patterns/">Common patterns</a>
·
Full <code>Boto3S3Storage</code> class:
<a href="/docs/storage/">Storage</a>
·
<a href="https://github.com/uploadkit/uploadkit-odoo" target="_blank" rel="noopener">uploadkit-odoo README</a>
</p>
"""
FLASK_VIEW = """from flask import current_app, jsonify, request
from uploadkit import Uploader, UploadPolicy, UploaderError
from uploadkit_flask import as_uploadable, get_storage_provider, json_error_response
from uploadkit_security import default_validators
def notify(result):
...
@app.post("/upload")
def upload_view():
storage = get_storage_provider()
policy = UploadPolicy(
max_size=5 * 1024 * 1024,
allowed_extensions=frozenset({"png"}),
allowed_mime_types=frozenset({"image/png"}),
validators=default_validators(),
)
uploaded = request.files["file"]
try:
result = Uploader(policy, storage).upload(
as_uploadable(uploaded),
bucket=current_app.config["UPLOADKIT_BUCKET"],
object_name=uploaded.filename,
after_upload=notify, # or Celery-like .delay
)
except UploaderError as exc:
return json_error_response(exc)
return jsonify({
"object_name": result.object_name,
"sha256": result.sha256,
"etag": result.etag,
})"""
FLASK_SETTINGS = """# app.config — AWS S3
app.config["AWS_ACCESS_KEY_ID"] = "AKIA..."
app.config["AWS_SECRET_ACCESS_KEY"] = "..."
app.config["AWS_S3_REGION_NAME"] = "eu-west-1"
app.config["UPLOADKIT_STORAGE_PROVIDER"] = "myapp.storage.get_provider"
app.config["UPLOADKIT_BUCKET"] = "my-prod-bucket"
# app.config — MinIO (instead of / in addition to keys)
# app.config["AWS_S3_ENDPOINT_URL"] = "http://127.0.0.1:9000"
# app.config["AWS_ACCESS_KEY_ID"] = "minioadmin"
# app.config["AWS_SECRET_ACCESS_KEY"] = "minioadmin"
# myapp/storage.py — Boto3S3Storage + get_provider()
# (full class in /docs/storage/)
def get_provider():
from flask import current_app
return Boto3S3Storage(
access_key=current_app.config["AWS_ACCESS_KEY_ID"],
secret_key=current_app.config["AWS_SECRET_ACCESS_KEY"],
region=current_app.config.get("AWS_S3_REGION_NAME", "us-east-1"),
endpoint_url=current_app.config.get("AWS_S3_ENDPOINT_URL"),
)"""
FLASK = f"""
<h1>Flask</h1>
<p class="section-lead">Thin integration over Core. Adapts Werkzeug <code>FileStorage</code>, maps <code>UploaderError</code> to JSON, and resolves storage from <code>app.config</code>. Pair with <code>uploadkit-security</code>. Python 3.10+, Flask 3.0+.</p>
<h2>Install</h2>
{install_tabs(
"flask",
"pip install uploadkit-flask uploadkit-security",
"uv add uploadkit-flask uploadkit-security",
"poetry add uploadkit-flask uploadkit-security",
)}
<h2>Adapter glue</h2>
<p class="section-note">Policy setup, validators, <code>UploaderError</code>, and the JSON response shape are shared — see <a href="/docs/patterns/">Common patterns</a>. <code>as_uploadable()</code> maps <code>FileStorage.filename</code> → Core <code>name</code> (form-field <code>name</code> is not the upload name).</p>
<div class="tabs nested-tabs" data-tabs="flask-inner">
<div class="tab-bar" role="tablist" aria-label="Flask examples">
<button type="button" class="tab-btn active" data-tab="tab-flask-view" role="tab" aria-selected="true">Route</button>
<button type="button" class="tab-btn" data-tab="tab-flask-settings" role="tab" aria-selected="false">Config</button>
</div>
<div id="tab-flask-view" class="tab-panel active" role="tabpanel">
<p class="section-note">Uses <code>get_storage_provider()</code> → <code>Boto3S3Storage</code> (AWS S3 or MinIO), <code>as_uploadable()</code>, and <code>json_error_response()</code>.</p>
{code_block("views.py", "python", FLASK_VIEW)}
</div>
<div id="tab-flask-settings" class="tab-panel" role="tabpanel">
<p class="section-note">Set <code>UPLOADKIT_STORAGE_PROVIDER</code> to a callable or dotted path. AWS: leave <code>AWS_S3_ENDPOINT_URL</code> unset. MinIO: set it to your endpoint.</p>
{code_block("app.config + storage.py", "python", FLASK_SETTINGS)}
</div>
</div>
<h2>Public API</h2>