FAQ for Developers¶
What coding style are you using?
We follow PEP 8 coding style with type-hint. We use flake8 to do the lint. Single quotes are preferred coding style for string notation. F-strings are the preferred string formatting syntax.
What is difference between
requirements.txt, should I add new dependency to
Jina only requires very few dependencies as described in
setup.py. Please keep the content empty (with a .) in
requirements.txt, so that
pipwon’t be confused when installing the dependencies.
extra-requirements.txtis the executor-specific dependency which Jina does not require but some certain executor may do. They are collected here so that one can cherry pick the dependencies via pip install "jina[xyz]".
More information about this trick can be found in this blog post .