wikmd icon indicating copy to clipboard operation
wikmd copied to clipboard

Improve project structure

Open Jerakin opened this issue 1 year ago • 3 comments

The project have all files dumped into the root. It would be a lot easier if the source files were moved into a sub folder. Either to a flat layout or a src layout.

flat layout

.
├── README.md
├── pyproject.toml
├── setup.py
├── wikmd/
│   ├── plugins/
│   ├── __init__.py
│   ├── cache.py
│   └── wiki.py
└── tests/
    ├──test_basics.py
    └── test_plugins.py

src layout

.
├── README.md
├── pyproject.toml
├── setup.py
├── src/
│    └── wikmd/
│            ├── plugins/
│            ├── __init__.py
│            ├── cache.py
│            └── wiki.py
└── tests/
    ├──test_basics.py
    └── test_plugins.py

Jerakin avatar Feb 19 '24 17:02 Jerakin

Hi @Jerakin,

This is a good idea, I was already looking into it, would also be handy to package wikmd. I guess my preference goes to the src-layout. If you think the other one would be better, let me know.

Linbreux avatar Feb 19 '24 18:02 Linbreux

I am also partial to a src layout. Are you looking into this and have something started or should I take a stab at it?

Jerakin avatar Feb 20 '24 22:02 Jerakin

Alright lets do it that way then. I did not work on it yet.

Linbreux avatar Feb 21 '24 08:02 Linbreux