Skip to content

docs: Enumerate Client constructor args #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Enumerate Client constructor args #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ The ``Client`` class manages all your interaction with the Contentful Delivery A

client = Client('space-id', 'access-token')

The constructor also takes the following keyword arguments:

- ``custom_entries`` (list) Optional list of `Entry` subclasses (see below)
- ``secure`` (bool) Indicates whether the connection should be encrypted or not, default: ``True``
- ``endpoint`` (str) Custom remote API endpoint, default: ``cdn.contentful.com``
- ``resolve_links`` (bool) Indicates whether or not to resolve links automatically, default: ``True``

------------------
Fetching Resources
------------------
Expand Down