import own module

[RandomCollection]

Hi,

I am trying to import and execute a self-written module using markdown-exec. It works perfectly well if example.py is restricted to standard packages but runs into ModuleNotFoundError errors when trying to import a self-written module. I have tried different specifications without success. Any advise is highly appreciated. Below the set-up:

I am using Python 3.8 with the following repository

- package
   - docs
      - example.md
      - examples
         - example.py
   - src
      - module.py

with example.md:

```python exec="on" source="console"
--8<-- "docs/examples/example.py"
```

and example.py:

from src.module import func

and module.py:

def func():
   pass

with mkdocs.yml:

plugins:
- search
- markdown-exec
- mkdocstrings:
    handlers:
      python:
        paths: [src]
        options:
          show_source: false 

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.snippets:
      check_paths: true
      base_path: ["src", "."]

Kind regards and many thanks

[pawamoy]

Hi!

You shouldn't try to import from src. Please see docs for the flat vs. src layouts here: https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/.

If your project is installed in the current venv (whatever the layout it uses), you should be able to import with from module import func.

Let me know if that helps 🙂

[RandomCollection]

Hi,

Installing the project in the current venv indeed resolved the issue. I initially assumed that would not be necessary, but I also had no idea about the src layout vs flat layout philosophy. I have learned a lot reading the discussions about it. Thank you very much for pointing me in that direction and for the quick response in general. Very much appreciated!

[pawamoy]

You're welcome, glad I could help 🙂