dev.rst

FAQ for Developers

1. What coding style are you using?

   We follow 8 coding style with type-hint. We use flake8 to do the lint.

2. What is difference between extra-requirements.txt and requirements.txt, should I add new dependency to requirements.txt?

   Jina only requires very few dependencies as described in setup.py. Please keep the content empty (with a .) in requirements.txt, so that pip won't be confused when installing the dependencies.

   extra-requirements.txt is 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 .