Linbreux / wikmd

A file based wiki that uses markdown
https://linbreux.github.io/wikmd/
MIT License
341 stars 37 forks source link

Project layout #144

Closed Jerakin closed 8 months ago

Jerakin commented 8 months ago

Summary

Attempt to modernize the project layout

Details

src layout

Moved python source and website files into a src/wikmd/ folder.

Added project.tom

Setting up a pyproject file. The file is commonly used to define project settings as well as a central location for other tools settings.

Removed requirements.txt

The requirements now live in the pyproject file and the common pip install -r requirements.txt is now replaced by doing pip install . to install from it. If you want the dev dependencies you can do pip install .[dev].

Dockerfile

Moved Dockerfile into root as well as tried to simplify it. However this is not my area of expertise so needs extra care to make sure everything is working.

Consider ruff

I think we should consider using ruff in the project as it is quickly becoming the way to ensure code consistency, however I haven't added it yet.

Work left

Jerakin commented 8 months ago

(Closing to reopen a new rebased MR (https://github.com/Linbreux/wikmd/pull/146))