Python module documentation

[mikhailnikolaev]

Documentation about adding and testing Python modules is added.

Note: reference to global runner documentation from the file /docs/python/Modules.md is currently broken, because such a documentation is in the PR #153

[tomjaguarpaw]

This looks nice.

[tomjaguarpaw]

By "global runner" do you mean run-all.ps1? If so could you say so?

[mikhailnikolaev]

I think it should be a reference to section describes what the global runner is (from Architecture.md). So, what do you think about the new version?

[tomjaguarpaw]

Yes, this is good.

[iliaeg]

It would be nice to write about adding CMakeLists and python requirements for new modules.
E.g.

• Add the following line to /src/python/modules/CMakeLists.txt:

    add_subdirectory ("<ModuleName>")

• Add to a new module directory
  1. requirements.txt with python requirements of a new module, e.g.

  scipy>=1.3.1
  setuptools>=41.0.0
  

  2. CMakeLists.txt with something like following

  project(<ModuleName>)
  
  execute_process(
      COMMAND ${Python3_EXECUTABLE} "-m" "pip" "install"
      "-r" "${CMAKE_CURRENT_SOURCE_DIR}/requirements.txt"
      )

  This command install required pip packages on configure stage of CMake.

[iliaeg]

@mikhailnikolaev if you think that adding python requirements is beyond of the scope of module documentation then I should add it to docker docs.

[mikhailnikolaev]

@mikhailnikolaev if you think that adding python requirements is beyond of the scope of module documentation then I should add it to docker docs.

Actually, I think that this stuff is about Docker, not about the Python modules. So, maybe, it is more proper to add it in a Docker docs

[iliaeg]

@mikhailnikolaev if you think that adding python requirements is beyond of the scope of module documentation then I should add it to docker docs.

Actually, I think that this stuff is about Docker, not about the Python modules. So, maybe, it is more proper to add it in a Docker docs

Okay, I had doubts about this, I will do so.

[msdmkats]

@mikhailnikolaev if you think that adding python requirements is beyond of the scope of module documentation then I should add it to docker docs.

Actually, I think that this stuff is about Docker, not about the Python modules. So, maybe, it is more proper to add it in a Docker docs

I disagree. First, this is about fetching dependencies as a part of CMake configuration/build. Second, this is supposed to be a guide on adding a new python module to ADBench. So, as a developer I would expect, that following steps listed here should be enough to do so. But without CMakeLists that won't be the case. So, I suggest, adding Ilia's paragraph to this doc.