Instalimi
Një paketë, tri varësi, Python 3.10 e më i ri.
Instalimi
Lëshimi aktual është 0.0.1. Ka një metodë për çdo metodë të SDK-së TypeScript, me të njëjtin emër në snake_case, dhe kontrolli i përputhshmërisë i paketës e dështon build-in kur njëra mungon ose dërgon një kërkesë tjetër.
pip install openemailimport os from openemail import init, openemail init(os.environ['OPENEMAIL_API_KEY']) email = openemail.emails.send({ 'from': 'Acme Billing <[email protected]>', 'to': '[email protected]', 'subject': 'Your September invoice', 'html': '<p>Invoice attached.</p>',}) print(email['id'], email['status'])init e konfiguron një herë klientin e përbashkët openemail, dhe çdo modul që importon openemail më pas e merr atë klient. Kapërcejeni dhe thirrja e parë e ndërton klientin nga OPENEMAIL_API_KEY.
Një trup kërkese është një dict i thjeshtë me emrat e fushave të vetë API-së, kështu që from, replyTo dhe scheduledAt lexohen saktësisht si në referencën e API-së, dhe edhe një përgjigje është një dict. Çdo trup dhe çdo përgjigje ka një TypedDict në openemail.types, kështu që redaktori juaj i plotëson çelësat dhe një kontrollues tipash kap një çelës të shkruar gabim.
Kthimi i send() nuk do të thotë se mesazhi është nisur. Një dërgim i planifikuar ose i anulueshëm kthehet si queued ose scheduled dhe përfundon më vonë. Lexoni status, jo faktin që thirrja u kthye.
Ku funksionon
Python 3.10 e më i ri, me tri varësi: httpx për HTTP, anyio për klientin asinkron dhe typing-extensions për tipet. Çdo kërkesë kalon përmes httpx, dhe mund t'i jepni httpx.Client-in tuaj, ose një httpx.AsyncClient për AsyncOpenEmail.
OpenEmail u përshtatet skripteve, worker-ave dhe aplikacioneve web sinkrone, ndërsa AsyncOpenEmail i përshtatet një cikli ngjarjesh, në asyncio ose trio. Të dy vijnë në këtë paketë të vetme me të njëjtat metoda.
Një klient mund të ndahet pa rrezik mes thread-eve, ndaj një procesi worker i mjafton vetëm një. Ai mban një pool lidhjesh, të cilin e mbyll close() ose fundi i një blloku with.
Paketa përfshin py.typed dhe kalon mypy dhe pyright në modalitetin strict, kështu që një kontrollues tipash e lexon çdo metodë, trup dhe përgjigje ashtu siç është shkruar.
Klienti mban një çelës API të hapësirës së punës që mund të dërgojë postë dhe të lexojë kutinë postare, ndaj vendi i tij është në një server, në një punë në sfond ose në një mjet që funksionon në makinën tuaj. Mbajeni çelësin në një variabël mjedisi ose në një menaxher sekretesh, kurrë në kod.