FAQ for Developers¶
What coding style do you use?
We follow the PEP 8 coding style, along with type annotations. Single quotes are the preferred coding style for string notation. F-strings are the preferred string formatting syntax. We follow the sphinx style for docstrings.
What is the difference between
requirements.txt? Should I add new dependencies 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 get confused when installing the dependencies.
extra-requirements.txtis the executor-specific dependency which Jina does not require but some certain executors 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 .