tortoise / tortoise/tortoise-orm

Example from README.md raises exception

Open
#745 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
5.6k
Forks
516
Avg merge
2d 21h
Merged PRs (30d)
9

Description

Describe the bug
Tried to use your ORM, followed steps from README.md and got an exception

To Reproduce

  1. Create file main.py
  2. Insert code from README.md
  3. Run it.

Expected behavior
No excpetion created

Actual behavior
Raised exception:
tortoise.exceptions.ConfigurationError: Module "app.models" not found

Additional context
Please add more clear description how to use your ORM, it's not obvious what is "app.models" and what should be a project structure.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with README.md and reproduce the example from main.py to confirm the ConfigurationError for app.models. Clarify what app.models refers to and show the expected project structure, then verify that a reader can follow the README example without the exception.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.