[GitHub] [streampipes] bossenti commented on issue #962: Example code in docs for Python code is rendered as markdown

[GitBox <gi...@apache.org>]

bossenti commented on issue #962:
URL: https://github.com/apache/streampipes/issues/962#issuecomment-1368492975

   Hi @CryoSolace,
   
   great that you are interested in contributing to StreamPipes 🚀 
   Here is one of the examples given in the pydocs:
   ```python
   Examples
   --------
   
   >>> from streampipes_client.client import StreamPipesClient
   >>> from streampipes_client.client.client_config import StreamPipesClientConfig
   >>> from streampipes_client.client.credential_provider import StreamPipesApiKeyCredentials
   
   >>> client_config = StreamPipesClientConfig(
   ...     credential_provider=StreamPipesApiKeyCredentials(
   ...         username="test-user",
   ...         api_key="api-key"
   ...     ),
   ...     host_address="localhost",
   ...     https_disabled=True
   ... )
   
   >>> client = StreamPipesClient.create(client_config=client_config)
   
   # The above way of instantiating a client instance is intended
   # to be consistent with the StreamPipes Java client.
   # If you prefer a more pythonic way, you can simply write:
   >>> client = StreamPipesClient(client_config=client_config)
   
   # Interact with an endpoint
   >>> data_lake_measures = client.dataLakeMeasureApi.all()
   
   # Inspect returned data as a pandas dataframe
   >>> data_lake_measures.to_pandas()
   
       measure_name timestamp_field  ... pipeline_is_running num_event_properties
   0           test   s0::timestamp  ...               False                    2
   [1 rows x 6 columns]
   ```
   Would be great if the whole code snippet would be rendered correctly in the docs.
   Please note our `make` commands for building the docs conventiently: `make doc` and `make livedoc` (see also [here](https://github.com/apache/streampipes/blob/dev/streampipes-client-python/Makefile))
   Is there anything else you need to get started?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@streampipes.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org