Skip to content

Commit

Permalink
Improve the RTD homepage (#295)
Browse files Browse the repository at this point in the history
* Improve the RTD homepage

Added more content from the README to RTD index to make the page
more filled.

* address review comments
  • Loading branch information
mdumandag committed Jan 11, 2021
1 parent ede5764 commit d96e86f
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Features
- Integration with `Hazelcast Cloud <https://cloud.hazelcast.com/>`__
- Support for serverless and traditional web service architectures with
**Unisocket** and **Smart** operation modes
- Ability to listen client lifecycle, cluster state and distributed
- Ability to listen to client lifecycle, cluster state, and distributed
data structure events
- and `many
more <https://hazelcast.org/imdg/clients-languages/python/#client-features>`__
Expand Down
55 changes: 55 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ Future-based asynchronous API suitable for wide ranges of use cases.
Overview
--------

Usage
~~~~~

.. code:: python
import hazelcast
Expand Down Expand Up @@ -59,6 +62,58 @@ Overview
client.shutdown()
If you are using Hazelcast IMDG and the Python client on the same
machine, the default configuration should work out-of-the-box. However,
you may need to configure the client to connect to cluster nodes that
are running on different machines or to customize client properties.

Configuration
~~~~~~~~~~~~~

.. code:: python
import hazelcast
client = hazelcast.HazelcastClient(
cluster_name="cluster-name",
cluster_members=[
"10.90.0.2:5701",
"10.90.0.3:5701",
],
lifecycle_listeners=[
lambda state: print("Lifecycle event >>>", state),
]
)
print("Connected to cluster")
client.shutdown()
See the API documentation of :class:`hazelcast.client.HazelcastClient`
to learn more about supported configuration options.

Features
--------

- Distributed, partitioned and queryable in-memory key-value store
implementation, called **Map**
- Eventually consistent cache implementation to store a subset of the
Map data locally in the memory of the client, called **Near Cache**
- Additional data structures and simple messaging constructs such as
**Set**, **MultiMap**, **Queue**, **Topic**
- Cluster-wide unique ID generator, called **FlakeIdGenerator**
- Distributed, CRDT based counter, called **PNCounter**
- Distributed concurrency primitives from CP Subsystem such as
**FencedLock**, **Semaphore**, **AtomicLong**
- Integration with `Hazelcast Cloud <https://cloud.hazelcast.com/>`__
- Support for serverless and traditional web service architectures with
**Unisocket** and **Smart** operation modes
- Ability to listen to client lifecycle, cluster state, and distributed
data structure events
- and `many
more <https://hazelcast.org/imdg/clients-languages/python/#client-features>`__


.. toctree::
:hidden:

Expand Down

0 comments on commit d96e86f

Please sign in to comment.