Skip to content

Commit ad328ee

Browse files
docs(readme): example snippet for client context manager (#413)
1 parent c0fd86e commit ad328ee

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,6 +414,16 @@ client.with_options(http_client=DefaultHttpxClient(...))
414414

415415
By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
416416

417+
```py
418+
from openlayer import Openlayer
419+
420+
with Openlayer() as client:
421+
# make requests here
422+
...
423+
424+
# HTTP client is now closed
425+
```
426+
417427
## Versioning
418428

419429
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:

0 commit comments

Comments
 (0)