documentation

This commit is contained in:
Hayden 2021-01-03 13:54:29 -09:00
parent 03197a139f
commit adbc126ef5
2 changed files with 22 additions and 1 deletions

View File

@ -1,10 +1,15 @@
# Working Todos
Frontend
- [ ] .Vue file reorganized into something that makes sense
- [ ] Recipe Print Page
- [x] Catch 400 / bad response on create from URL
- [ ] Recipe Editor Data Validation CLient Side
- [x] Favicon
- [x] Rename Window
- [ ] Add version indicator and notification for new version available
- [ ] Enhanced Search Functionality
- [ ] Organize Home Page my Category, ideally user selectable.
Backend
- [x] Add Debug folder for writing the last pulled recipe data to.
@ -12,11 +17,16 @@ Backend
- [ ] Normalize Recipe data on scrape
- [ ] Support how to Sections
- [ ] Export Markdown on Auto backups
- [ ] Recipe request by category/tags
- [ ] Add Additional Migrations, See mealie/services/migrations/chowdown.py for examples of how to do this.
- [ ] Open Eats [See Issue #4](https://github.com/hay-kot/mealie/issues/4)
- [ ] NextCloud [See Issue #14](https://github.com/hay-kot/mealie/issues/14)
# Draft Changelog
## v0.0.1
General
- Fixed opacity issues with marked steps - [mtoohey31](https://github.com/mtoohey31)
- Updated Favicon
- Renamed Frontend Window
- Added Debug folder to dump scraper data prior to processing.

View File

@ -29,6 +29,18 @@ def pull_repo(repo):
def read_chowdown_file(recipe_file: Path) -> Recipe:
"""Parse through the yaml file to try and pull out the relavent information.
Some issues occur when ":" are used in the text. I have no put a lot of effort
into this so there may be better ways of going about it. Currently, I get about 80-90%
of recipes from repos I've tried.
Args:
recipe_file (Path): Path to the .yml file
Returns:
Recipe: Recipe class object
"""
with open(recipe_file, "r") as stream:
recipe_description: str = str
recipe_data: dict = {}
@ -85,7 +97,6 @@ def chowdown_migrate(repo):
except:
failed_recipes.append(recipe.name)
report = {"failedImages": failed_images, "failedRecipes": failed_recipes}
return report