Hi Florian,
there is no need to know a lot of the backend as the Python client is
completely independent.
In the current state it aims only to provide a wrapper around the
StreamPipes API which can be discovered in the API docs.
Therefore, an easy aspect to contribute is the implementation of
additional endpoints (currently there is only one).
If you have problems to getting started, I'm happy to assist and give
you an indtroduction in the codebase.
The pre-commit hook does not have any influence or relation to the
backend or StreamPipes in general.
This is just a simple script that is executed by Git before a commit is
completed.
In general, you can do whatever you want in a pre-commit hook, in case
of the Python client we use for some tools for code style, linting and
import omptimization.
That's done to have committed code in the same quality in terms of code
style etc.
A pre-commit hook needs to be registered ("installed") in git, that what
the installation described in the README does.
Sofar, the pre-commit hook is just setup for the Python client.
No other files are affected by it.
Philipp just propesed to add such a pre-commit hook gradually also for
the rest of our codebase (mainly Java and typescript).
I hope that answers your question.
Best
Tim
Am 17.11.2022 19:21 schrieb Florian Micklich:
Hi Tim,
is there a way to contribute? I don't know much about the backend atm.
In the Readme you mentioned "Install pre-commit hook" What does it
exactly mean? What is happening here in the backend and why? Also a
comment in the GitHub pull request I don't understand: "We should also
discuss how we can add the pre-commit hooks for java and typescript
code"
Greetings Florian
Am Montag, dem 14.11.2022 um 10:44 +0530 schrieb Anush:
I think a python client would be ideal as it improves accessiblity
and
provide an easier way to utilize the API.
As a Python developer, I usually look for a client library before I
use an
API directly.
I would be happy to join in and contribute to this. I have
previously
contributed to the python wrapper a year ago.
On Sun, 13 Nov 2022 at 19:44, Tim <[email protected]> wrote:
Hi everyone,
I have been working on the general structure of a counterpart to
our
Java client for StreamPipes in Python.
PR-140 [1] contains a basic framework for the client in general
and a
first reference implementation for an API endpoint.
I'm curious to hear your feedback and discuss some aspects (I've
already
started some in the PR's comments).
Best,
Tim
[1] https://github.com/apache/incubator-streampipes/pull/140 [1]
Links:
------
[1] https://github.com/apache/incubator-streampipes/pull/140
