diff --git a/.dockerignore b/.dockerignore index cc5da2130..b0f176b1d 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,3 +1,2 @@ */node_modules */dist -## \ No newline at end of file diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 3a7a0116e..3712b2cff 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -2,7 +2,7 @@ name: Publish docs via GitHub Pages on: push: branches: - - main + - master jobs: build: @@ -17,4 +17,4 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} CONFIG_FILE: docs/mkdocs.yml - EXTRA_PACKAGES: build-base \ No newline at end of file + EXTRA_PACKAGES: build-base diff --git a/.gitignore b/.gitignore index 72fca36ef..6aaeb2234 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ __pycache__/ docs/site/ mealie/temp/* mealie/temp/api.html +.temp/ mealie/data/backups/* @@ -151,3 +152,130 @@ ENV/ # Node Modules node_modules/ mealie/data/debug/last_recipe.json +mealie/data/temp/active_import/images/.gitkeep +mealie/data/temp/active_import/images/banana-bread.jpg +mealie/data/temp/active_import/images/bon-appetit-s-perfect-pizza.jpg +mealie/data/temp/active_import/images/braised-beans-and-sardines-with-fennel.jpg +mealie/data/temp/active_import/images/broccoli-beer-cheese-soup.jpg +mealie/data/temp/active_import/images/buttery-kimchi-chicken.jpg +mealie/data/temp/active_import/images/cauliflower-cacciatore.jpg +mealie/data/temp/active_import/images/chicken-salad-with-citrus-and-chile-oil.jpg +mealie/data/temp/active_import/images/coffee-hazelnut-biscotti.jpg +mealie/data/temp/active_import/images/corn-and-crab-beignets-with-yaji-aioli.jpg +mealie/data/temp/active_import/images/crispy-carrots.jpg +mealie/data/temp/active_import/images/crispy-rice-with-ginger-citrus-celery-salad.jpg +mealie/data/temp/active_import/images/crockpot-buffalo-chicken.jpg +mealie/data/temp/active_import/images/detroit-style-pepperoni-pizza.jpg +mealie/data/temp/active_import/images/downtown-marinade.jpg +mealie/data/temp/active_import/images/falafel-hummus-plate.jpg +mealie/data/temp/active_import/images/five-spice-popcorn-chicken.jpg +mealie/data/temp/active_import/images/ginger-citrus-cookies.jpg +mealie/data/temp/active_import/images/green-chile-stew.jpg +mealie/data/temp/active_import/images/green-seasoning-baked-cod.jpg +mealie/data/temp/active_import/images/green-spaghetti.jpg +mealie/data/temp/active_import/images/huevos-rancheros-con-rajas-y-champinones.jpg +mealie/data/temp/active_import/images/jalapeno-cornbread.jpg +mealie/data/temp/active_import/images/marinated-tofu-with-brussels-sprouts-and-farro.jpg +mealie/data/temp/active_import/images/marranitos-enfiestados.jpg +mealie/data/temp/active_import/images/mississippi-pot-roast.jpg +mealie/data/temp/active_import/images/mushroom-risotto.jpg +mealie/data/temp/active_import/images/new-york-strip.jpg +mealie/data/temp/active_import/images/nilla-wafer-french-toast.jpg +mealie/data/temp/active_import/images/one-minute-muffin.jpg +mealie/data/temp/active_import/images/one-pot-chicken-and-rice.jpg +mealie/data/temp/active_import/images/pace-pork.jpg +mealie/data/temp/active_import/images/pasta-with-mushrooms-and-cashew-cream.jpg +mealie/data/temp/active_import/images/pizzettes.jpg +mealie/data/temp/active_import/images/pork-steaks.jpg +mealie/data/temp/active_import/images/roasted-brussels-sprouts.jpg +mealie/data/temp/active_import/images/roasted-okra.jpg +mealie/data/temp/active_import/images/salt-vinegar-potatoes.jpg +mealie/data/temp/active_import/images/shrimp-and-cabbage-curry.jpg +mealie/data/temp/active_import/images/smashed-carrots.jpg +mealie/data/temp/active_import/images/tamarind-chicken-thighs-with-collard-greens-salad.jpg +mealie/data/temp/active_import/images/tequila-beer-and-citrus-cocktail.jpg +mealie/data/temp/active_import/recipes/banana-bread.json +mealie/data/temp/active_import/recipes/bon-appetit-s-perfect-pizza.json +mealie/data/temp/active_import/recipes/braised-beans-and-sardines-with-fennel.json +mealie/data/temp/active_import/recipes/broccoli-beer-cheese-soup.json +mealie/data/temp/active_import/recipes/buttery-kimchi-chicken.json +mealie/data/temp/active_import/recipes/cauliflower-cacciatore.json +mealie/data/temp/active_import/recipes/chicken-salad-with-citrus-and-chile-oil.json +mealie/data/temp/active_import/recipes/coffee-hazelnut-biscotti.json +mealie/data/temp/active_import/recipes/corn-and-crab-beignets-with-yaji-aioli.json +mealie/data/temp/active_import/recipes/crispy-carrots.json +mealie/data/temp/active_import/recipes/crispy-rice-with-ginger-citrus-celery-salad.json +mealie/data/temp/active_import/recipes/crockpot-buffalo-chicken.json +mealie/data/temp/active_import/recipes/detroit-style-pepperoni-pizza.json +mealie/data/temp/active_import/recipes/downtown-marinade.json +mealie/data/temp/active_import/recipes/falafel-hummus-plate.json +mealie/data/temp/active_import/recipes/five-spice-popcorn-chicken.json +mealie/data/temp/active_import/recipes/ginger-citrus-cookies.json +mealie/data/temp/active_import/recipes/green-chile-stew.json +mealie/data/temp/active_import/recipes/green-seasoning-baked-cod.json +mealie/data/temp/active_import/recipes/green-spaghetti.json +mealie/data/temp/active_import/recipes/huevos-rancheros-con-rajas-y-champinones.json +mealie/data/temp/active_import/recipes/jalapeno-cornbread.json +mealie/data/temp/active_import/recipes/marinated-tofu-with-brussels-sprouts-and-farro.json +mealie/data/temp/active_import/recipes/marranitos-enfiestados.json +mealie/data/temp/active_import/recipes/mississippi-pot-roast.json +mealie/data/temp/active_import/recipes/mushroom-risotto.json +mealie/data/temp/active_import/recipes/new-york-strip.json +mealie/data/temp/active_import/recipes/nilla-wafer-french-toast.json +mealie/data/temp/active_import/recipes/one-minute-muffin.json +mealie/data/temp/active_import/recipes/one-pot-chicken-and-rice.json +mealie/data/temp/active_import/recipes/pace-pork.json +mealie/data/temp/active_import/recipes/pasta-with-mushrooms-and-cashew-cream.json +mealie/data/temp/active_import/recipes/pizzettes.json +mealie/data/temp/active_import/recipes/pork-steaks.json +mealie/data/temp/active_import/recipes/roasted-brussels-sprouts.json +mealie/data/temp/active_import/recipes/roasted-okra.json +mealie/data/temp/active_import/recipes/salt-vinegar-potatoes.json +mealie/data/temp/active_import/recipes/shrimp-and-cabbage-curry.json +mealie/data/temp/active_import/recipes/smashed-carrots.json +mealie/data/temp/active_import/recipes/tamarind-chicken-thighs-with-collard-greens-salad.json +mealie/data/temp/active_import/recipes/tequila-beer-and-citrus-cocktail.json +mealie/data/temp/active_import/settings/settings.json +mealie/data/temp/active_import/templates/Banana Bread.md +mealie/data/temp/active_import/templates/Bon Appétit's Perfect Pizza.md +mealie/data/temp/active_import/templates/Braised Beans and Sardines With Fennel.md +mealie/data/temp/active_import/templates/Broccoli Beer Cheese Soup.md +mealie/data/temp/active_import/templates/Buttery Kimchi Chicken.md +mealie/data/temp/active_import/templates/Cauliflower Cacciatore.md +mealie/data/temp/active_import/templates/Chicken Salad With Citrus and Chile Oil.md +mealie/data/temp/active_import/templates/Coffee-Hazelnut Biscotti.md +mealie/data/temp/active_import/templates/Corn and Crab Beignets With Yaji Aioli.md +mealie/data/temp/active_import/templates/Crispy Carrots.md +mealie/data/temp/active_import/templates/Crispy Rice With Ginger-Citrus Celery Salad.md +mealie/data/temp/active_import/templates/Crockpot Buffalo Chicken.md +mealie/data/temp/active_import/templates/Detroit-Style Pepperoni Pizza.md +mealie/data/temp/active_import/templates/Downtown Marinade.md +mealie/data/temp/active_import/templates/Falafel-Hummus Plate.md +mealie/data/temp/active_import/templates/Five Spice Popcorn Chicken.md +mealie/data/temp/active_import/templates/Ginger-Citrus Cookies.md +mealie/data/temp/active_import/templates/Green Chile Stew.md +mealie/data/temp/active_import/templates/Green Seasoning Baked Cod.md +mealie/data/temp/active_import/templates/Green Spaghetti.md +mealie/data/temp/active_import/templates/Huevos Rancheros con Rajas y Champiñones.md +mealie/data/temp/active_import/templates/Jalapeno Cornbread.md +mealie/data/temp/active_import/templates/Marinated Tofu With Brussels Sprouts and Farro.md +mealie/data/temp/active_import/templates/Marranitos Enfiestados.md +mealie/data/temp/active_import/templates/Mississippi Pot Roast.md +mealie/data/temp/active_import/templates/Mushroom Risotto.md +mealie/data/temp/active_import/templates/New York Strip.md +mealie/data/temp/active_import/templates/Nilla Wafer French Toast.md +mealie/data/temp/active_import/templates/One Minute Muffin.md +mealie/data/temp/active_import/templates/One-Pot Chicken and Rice.md +mealie/data/temp/active_import/templates/Pace Pork.md +mealie/data/temp/active_import/templates/Pasta With Mushrooms and Cashew Cream.md +mealie/data/temp/active_import/templates/Pizzettes.md +mealie/data/temp/active_import/templates/Pork Steaks.md +mealie/data/temp/active_import/templates/Roasted Brussels Sprouts.md +mealie/data/temp/active_import/templates/Roasted Okra.md +mealie/data/temp/active_import/templates/Salt & Vinegar Potatoes.md +mealie/data/temp/active_import/templates/Shrimp and Cabbage Curry.md +mealie/data/temp/active_import/templates/Smashed Carrots.md +mealie/data/temp/active_import/templates/Tamarind Chicken Thighs With Collard Greens Salad.md +mealie/data/temp/active_import/templates/Tequila, Beer, and Citrus Cocktail.md +mealie/data/temp/active_import/themes/themes.json +mealie/data/mealie.sqlite diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 000000000..c149059af --- /dev/null +++ b/.pylintrc @@ -0,0 +1,588 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-whitelist= + +# Specify a score threshold to be exceeded before program exits with error. +fail-under=10.0 + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=print-statement, + parameter-unpacking, + unpacking-in-except, + old-raise-syntax, + backtick, + long-suffix, + old-ne-operator, + old-octal-literal, + import-star-module-level, + non-ascii-bytes-literal, + raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + apply-builtin, + basestring-builtin, + buffer-builtin, + cmp-builtin, + coerce-builtin, + execfile-builtin, + file-builtin, + long-builtin, + raw_input-builtin, + reduce-builtin, + standarderror-builtin, + unicode-builtin, + xrange-builtin, + coerce-method, + delslice-method, + getslice-method, + setslice-method, + no-absolute-import, + old-division, + dict-iter-method, + dict-view-method, + next-method-called, + metaclass-assignment, + indexing-exception, + raising-string, + reload-builtin, + oct-method, + hex-method, + nonzero-method, + cmp-method, + input-builtin, + round-builtin, + intern-builtin, + unichr-builtin, + map-builtin-not-iterating, + zip-builtin-not-iterating, + range-builtin-not-iterating, + filter-builtin-not-iterating, + using-cmp-argument, + eq-without-hash, + div-method, + idiv-method, + rdiv-method, + exception-message-attribute, + invalid-str-codec, + sys-max-int, + bad-python3-import, + deprecated-string-function, + deprecated-str-translate-call, + deprecated-itertools-function, + deprecated-types-field, + next-method-defined, + dict-items-not-iterating, + dict-keys-not-iterating, + dict-values-not-iterating, + deprecated-operator-function, + deprecated-urllib-function, + xreadlines-attribute, + deprecated-sys-function, + exception-escape, + comprehension-escape + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'error', 'warning', 'refactor', and 'convention' +# which contain the number of messages in each category, as well as 'statement' +# which is the total number of statements analyzed. This score is used by the +# global evaluation report (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +#notes-rgx= + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members=pydantic.* + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes +w54 +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[DESIGN] + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled). +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled). +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=BaseException, + Exception diff --git a/.vscode/settings.json b/.vscode/settings.json index a3a758516..24b79e7fc 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,6 +1,6 @@ { "python.formatting.provider": "black", - "python.pythonPath": "venv/bin/python", + "python.pythonPath": ".venv/bin/python3.8", "python.linting.pylintEnabled": true, "python.linting.enabled": true, "python.autoComplete.extraPaths": ["mealie", "mealie/mealie"], @@ -8,18 +8,12 @@ "python.testing.unittestEnabled": false, "python.testing.nosetestsEnabled": false, - "python.discoverTest": true, "python.testing.pytestEnabled": true, - "cSpell.enableFiletypes": [ - "!javascript", - "!python" - ], + "cSpell.enableFiletypes": ["!javascript", "!python"], + "python.testing.pytestArgs": ["mealie"], "i18n-ally.localesPaths": "frontend/src/locales", "i18n-ally.enabledFrameworks": [ "vue" ], - "i18n-ally.keystyle": "nested", - "python.testing.pytestArgs": [ - "mealie" - ] + "i18n-ally.keystyle": "nested" } diff --git a/Dockerfile.dev b/Dockerfile.dev index de37b9cc1..b22f5ca4d 100644 --- a/Dockerfile.dev +++ b/Dockerfile.dev @@ -3,13 +3,16 @@ FROM python:3 RUN apt-get update -y && \ apt-get install -y python-pip python-dev - -COPY ./requirements.txt /app/requirements.txt +RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | POETRY_HOME=/opt/poetry python && \ + cd /usr/local/bin && \ + ln -s /opt/poetry/bin/poetry && \ + poetry config virtualenvs.create false + +COPY ./pyproject.toml ./app/poetry.lock* /app/ WORKDIR /app -RUN pip install -r requirements.txt -RUN pip install pytest +RUN poetry install --no-root COPY ./mealie /app diff --git a/dev/dev-notes.md b/dev/dev-notes.md index a1b0d7108..efa32af75 100644 --- a/dev/dev-notes.md +++ b/dev/dev-notes.md @@ -16,27 +16,39 @@ Don't forget to [join the Discord](https://discord.gg/R6QDyJgbD2)! # Todo's +Documentation +- [ ] V0.1.0 Release Notes +- [ ] Nextcloud Migration How To +- [ ] New Docker Setup with Sqlite +- [ ] Update Env Variables +- [ ] New Roadmap / Milestones + Frontend -- [x] .Vue file reorganized into something that makes sense +- [ ] Prep / Cook / Total Time Indicator + Editor +- [ ] No Meal Today Page instead of Null - [ ] Recipe Print Page -- [x] Catch 400 / bad response on create from URL - [ ] Recipe Editor Data Validation Client Side -- [x] Favicon -- [x] Rename Window -- [x] Add version indicator and notification for new version available -- [ ] Enhanced Search Functionality - [ ] Organize Home Page my Category, ideally user selectable. +- [ ] Advanced Search Page, draft started +- [ ] Search Bar Re-design +- [ ] Replace Backups card with something like Home Assistant +- [ ] Replace import card with something like Home Assistant + - [ ] Select which imports to do Backend -- [x] Add Debug folder for writing the last pulled recipe data to. -- [x] Recipe Editor Data Validation Server Side -- [ ] Normalize Recipe data on scrape +- [ ] Database Import + - [x] Recipes + - [x] Images + - [ ] Meal Plans + - [ ] Settings + - [ ] Themes +- [ ] Remove Print / Debug Code - [ ] Support how to Sections and how to steps -- [ ] 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) + + +SQL +- [ ] Setup Database Migrations # Draft Changelog ## v0.0.2 diff --git a/mealie/scratch.py b/dev/manual_tests.md similarity index 100% rename from mealie/scratch.py rename to dev/manual_tests.md diff --git a/dev/scratch/write_settings.py b/dev/scratch/write_settings.py index 21b897dbc..a76bcd023 100644 --- a/dev/scratch/write_settings.py +++ b/dev/scratch/write_settings.py @@ -37,4 +37,3 @@ if __name__ == "__main__": data = json.dumps(theme) response = requests.post(POST_URL, data) response = requests.get(GET_URL) - print(response.text) diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml index 72b5f9a84..c7ea72e98 100644 --- a/docker-compose.dev.yml +++ b/docker-compose.dev.yml @@ -34,6 +34,14 @@ services: volumes: - ./mealie:/app + mealie-docs: + image: squidfunk/mkdocs-material + restart: always + ports: + - 9924:8000 + volumes: + - ./docs:/docs + # Database mongo: image: mongo diff --git a/docs/docs/changelog.md b/docs/docs/changelog.md index 267eae44a..bf68e755d 100644 --- a/docs/docs/changelog.md +++ b/docs/docs/changelog.md @@ -1,7 +1,32 @@ # Release Notes +## v0.1.0 - Initial Beta +### Bug Fixes + - Fixed Can't delete recipe after changing name - Closes Issue #67 + - Fixed No image when added by URL, and can;t add an image - Closes Issue #66 + - Fixed Images saved with no way to delete when add recipe via URL fails - Closes Issue #43 + +### Features + - Additional database! sqlite is now supported! Closes #48 + - All site data is now backed up. + + +### Code Improvements + - Unified Database Access Layers + - Poetry / pyproject.toml support + - Local development without database is now possible! + - Major code refactoring to support new database layer + - Global variable refactor + +### Break Changes + +!!! warning + As I've adopted the SQL database model I find that using 2 different types of databases will inevitably hinder development. As such after release v0.1.0 support for mongoDB will not longer be available. Prior to upgrading to v0.2.0 you will need to export your site and import your settings after updating. This should be a painless process and require minimal intervention on the users part. Moving forward we will do our best to minimize changes that require user intervention like this. + + ## v0.0.2 - Pre-release Second Patch A quality update with major props to [zackbcom](https://github.com/zackbcom) for working hard on making the theming just that much better! + ### Bug Fixes - Fixed empty backup failure without markdown template - Fixed opacity issues with marked steps - [mtoohey31](https://github.com/mtoohey31) diff --git a/docs/docs/getting-started/backups-and-exports.md b/docs/docs/getting-started/backups-and-exports.md index f20e0c32d..668ddb3e8 100644 --- a/docs/docs/getting-started/backups-and-exports.md +++ b/docs/docs/getting-started/backups-and-exports.md @@ -3,7 +3,7 @@ All recipe data can be imported and exported as necessary from the UI. Under the admin page you'll find the section for using Backups and Exports. -To create an export simple add the tag and the markdown template and click Backup Recipes and your backup will be created on the server. The backup is a standard zipfile containing all the images, json files, and rendered markdown files for each recipe. Markdown files are rendered from jinja2 templates. Adding your own markdown file into the templates folder will automatically show up as an option to select when creating a backup. To view the availible variables, open a recipe in the json editor. +To create an export simple add the tag and the markdown template and click Backup Recipes and your backup will be created on the server. The backup is a standard zipfile containing all the images, json files, and rendered markdown files for each recipe. Markdown files are rendered from jinja2 templates. Adding your own markdown file into the templates folder will automatically show up as an option to select when creating a backup. To view the available variables, open a recipe in the json editor. To import a backup it must be in your backups folder. If it is in the backup folder it will automatically show up as an source to restore from. Selected the desired backup and import the backup file. diff --git a/docs/docs/img/app_diagram.drawio.svg b/docs/docs/img/app_diagram.drawio.svg new file mode 100644 index 000000000..d8fa0877a --- /dev/null +++ b/docs/docs/img/app_diagram.drawio.svg @@ -0,0 +1,138 @@ + + + + + + + + + + + +
+
+
+ Models +
+
+
+ + + Models + + + + + + + +
+
+
+ Database +
+
+
+ + + Database + + + + + + + + + + + + + + +
+
+
+ Python Dictionary +
+
+
+ + + Python Dictio... + + + + + + + + + + + +
+
+
+ Pydantic Model +
+
+
+ + + Pydantic Mo... + + + + + + + + + + + + +
+
+
+ Services +
+
+
+ + + Services + + + + + + + +
+
+
+ API Endpoints +
+
+
+ + + API Endpoin... + + + + + + + + + + + + Viewer does not support full SVG 1.1 + + + + \ No newline at end of file diff --git a/frontend/package-lock.json b/frontend/package-lock.json index 22eeb9f5c..21680b6fb 100644 --- a/frontend/package-lock.json +++ b/frontend/package-lock.json @@ -1748,16 +1748,6 @@ "integrity": "sha1-/q7SVZc9LndVW4PbwIhRpsY1IPo=", "dev": true }, - "ansi-styles": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", - "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", - "dev": true, - "optional": true, - "requires": { - "color-convert": "^2.0.1" - } - }, "cacache": { "version": "13.0.1", "resolved": "https://registry.npm.taobao.org/cacache/download/cacache-13.0.1.tgz?cache=0&sync_timestamp=1594428402513&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fcacache%2Fdownload%2Fcacache-13.0.1.tgz", @@ -1784,34 +1774,6 @@ "unique-filename": "^1.1.1" } }, - "chalk": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz", - "integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==", - "dev": true, - "optional": true, - "requires": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - } - }, - "color-convert": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", - "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, - "optional": true, - "requires": { - "color-name": "~1.1.4" - } - }, - "color-name": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true, - "optional": true - }, "find-cache-dir": { "version": "3.3.1", "resolved": "https://registry.npm.taobao.org/find-cache-dir/download/find-cache-dir-3.3.1.tgz?cache=0&sync_timestamp=1583735626956&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Ffind-cache-dir%2Fdownload%2Ffind-cache-dir-3.3.1.tgz", @@ -1833,25 +1795,6 @@ "path-exists": "^4.0.0" } }, - "has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true, - "optional": true - }, - "loader-utils": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.0.tgz", - "integrity": "sha512-rP4F0h2RaWSvPEkD7BLDFQnvSf+nK+wr3ESUjNTyAGobqrijmW92zc+SO6d4p4B1wh7+B/Jg1mkQe5NYUEHtHQ==", - "dev": true, - "optional": true, - "requires": { - "big.js": "^5.2.2", - "emojis-list": "^3.0.0", - "json5": "^2.1.2" - } - }, "locate-path": { "version": "5.0.0", "resolved": "https://registry.npm.taobao.org/locate-path/download/locate-path-5.0.0.tgz?cache=0&sync_timestamp=1597081764621&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Flocate-path%2Fdownload%2Flocate-path-5.0.0.tgz", @@ -1916,16 +1859,6 @@ "minipass": "^3.1.1" } }, - "supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "optional": true, - "requires": { - "has-flag": "^4.0.0" - } - }, "terser-webpack-plugin": { "version": "2.3.8", "resolved": "https://registry.npm.taobao.org/terser-webpack-plugin/download/terser-webpack-plugin-2.3.8.tgz?cache=0&sync_timestamp=1603882075288&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fterser-webpack-plugin%2Fdownload%2Fterser-webpack-plugin-2.3.8.tgz", @@ -1942,18 +1875,6 @@ "terser": "^4.6.12", "webpack-sources": "^1.4.3" } - }, - "vue-loader-v16": { - "version": "npm:vue-loader@16.1.2", - "resolved": "https://registry.npmjs.org/vue-loader/-/vue-loader-16.1.2.tgz", - "integrity": "sha512-8QTxh+Fd+HB6fiL52iEVLKqE9N1JSlMXLR92Ijm6g8PZrwIxckgpqjPDWRP5TWxdiPaHR+alUWsnu1ShQOwt+Q==", - "dev": true, - "optional": true, - "requires": { - "chalk": "^4.1.0", - "hash-sum": "^2.0.0", - "loader-utils": "^2.0.0" - } } } }, @@ -5673,6 +5594,11 @@ "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", "dev": true }, + "fuse.js": { + "version": "6.4.6", + "resolved": "https://registry.npmjs.org/fuse.js/-/fuse.js-6.4.6.tgz", + "integrity": "sha512-/gYxR/0VpXmWSfZOIPS3rWwU8SHgsRTwWuXhyb2O6s7aRuVtHtxCkR33bNYu3wyLyNx/Wpv0vU7FZy8Vj53VNw==" + }, "gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npm.taobao.org/gensync/download/gensync-1.0.0-beta.2.tgz?cache=0&sync_timestamp=1603829621482&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fgensync%2Fdownload%2Fgensync-1.0.0-beta.2.tgz", @@ -11255,6 +11181,87 @@ } } }, + "vue-loader-v16": { + "version": "npm:vue-loader@16.1.2", + "resolved": "https://registry.npmjs.org/vue-loader/-/vue-loader-16.1.2.tgz", + "integrity": "sha512-8QTxh+Fd+HB6fiL52iEVLKqE9N1JSlMXLR92Ijm6g8PZrwIxckgpqjPDWRP5TWxdiPaHR+alUWsnu1ShQOwt+Q==", + "dev": true, + "optional": true, + "requires": { + "chalk": "^4.1.0", + "hash-sum": "^2.0.0", + "loader-utils": "^2.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "optional": true, + "requires": { + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz", + "integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==", + "dev": true, + "optional": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "optional": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "optional": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "optional": true + }, + "loader-utils": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.0.tgz", + "integrity": "sha512-rP4F0h2RaWSvPEkD7BLDFQnvSf+nK+wr3ESUjNTyAGobqrijmW92zc+SO6d4p4B1wh7+B/Jg1mkQe5NYUEHtHQ==", + "dev": true, + "optional": true, + "requires": { + "big.js": "^5.2.2", + "emojis-list": "^3.0.0", + "json5": "^2.1.2" + } + }, + "supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "optional": true, + "requires": { + "has-flag": "^4.0.0" + } + } + } + }, "vue-router": { "version": "3.4.9", "resolved": "https://registry.npmjs.org/vue-router/-/vue-router-3.4.9.tgz", diff --git a/frontend/package.json b/frontend/package.json index 82a311a35..feb2ff534 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -11,6 +11,7 @@ "dependencies": { "axios": "^0.21.1", "core-js": "^3.8.2", + "fuse.js": "^6.4.6", "qs": "^6.9.4", "v-jsoneditor": "^1.4.2", "vue": "^2.6.11", diff --git a/frontend/src/App.vue b/frontend/src/App.vue index 0e33a66d5..132fe276b 100644 --- a/frontend/src/App.vue +++ b/frontend/src/App.vue @@ -1,17 +1,22 @@