migrate to python standard project layout

[bmerkle]

Before we make further improvement, i would suggest to tackle the following two small issues from TODO.md

Development Infrastructure

P3 - Low Priority

• [P3, small] Move typeagent into src/
• [P3, tiny] Move test/ to tests/

The idea would be to migrate to a python standard project layout:

• no semantic code changes
• follow python standard project layout (for ML/AI projects)
• if necessary adopt config files, scripts etc to
• preserve history via git mv commands

migration for typeagent-py

typeagent-py/
├─ pyproject.toml (etc)
├─ README.md (etc)
├─ Makefile (etc)
├─ data/
│ ├─ demo.db (etc)
├─ docs/
│ └─ spec/
├─ src/
│ └─ typeagent/
│ ├─ init.py
│ ├─ dataset.py
│ ├─ model.py
│ └─ train.py
├─ examples/
│ └─ demo/
│ └─ examples/
├─ tests/
│ └─ test_model.py
│ └─ testdata
├─ tools/
│ └─ gmail/

migration steps

• introduce src 125 src-create
  mkdir src
  git add src
  git mv typeagent src/typeagent

• move test 125-tests
  git mv test tests
  git mv testdata tests/testdata

• consolidate examples 125-examples
  git mv demo examples/demo
  git mv samples examples/samples
  git mv gmail tools/gmail

• afterwards we decide which are outdated or should be updated/removed/new added

• move spec-to-docs 125-spec
  git mv spec docs/spec

questions

• shoud we move *.db to data/ (and adopt .gitignore)
• should we move some of the .md files to doc/ (which one)
• we should have a .env-template file (as example for .env) only containing names of the API-KEYS...

[bmerkle]

I would prepare a PR, as described above, but would need your opinion @gvanrossum about layout and the open questions.
Feel free to edit also the initial issue description. Thanks you so much.

[gvanrossum]

Leave tools where it is. Don't move the .md files yet. Don't do the samples. I propose separate PRs for src and tests and not changing anything else in this round.

[gvanrossum]

Do update TODO.

[gvanrossum]

Don't move dist -- IIRC it's the default destination used by uv's default build tool.

[bmerkle]

Do update TODO.

do you mean i should move it to docs or update only the content ?
I will update TODO.md content once we are through this issue.

[gvanrossum]

Two things I just realized.

• examples should disappear -- the one file there is outdated.
• gmail/ should move into tools/.

[bmerkle]

Two things I just realized.

• examples should disappear -- the one file there is outdated.
• gmail/ should move into tools/.

yup, this is on the list for the next PR which is already prepared :-)

next steps are:

git mv test tests

mkdir samples
git add samples
git mv demo samples/demo
git mv examples samples/examples
git mv gmail tools/gmail
git mv testdata samples/testdata

git mv spec docs/spec

[bmerkle]

why gmail to tools ? Is this not specific to a sample/demo ?

[gvanrossum]

why gmail to tools ? Is this not specific to a sample/demo ?

It nevertheless is a tool. It doesn't belong in demo/, which is a much simpler demo (from the talk, basically, and from the docs).