Andréas Livet
2 years ago
commit
7990efc623
10 changed files with 349 additions and 0 deletions
@ -0,0 +1,156 @@
|
||||
|
||||
# Created by https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks |
||||
# Edit at https://www.toptal.com/developers/gitignore?templates=python,jupyternotebooks |
||||
|
||||
### JupyterNotebooks ### |
||||
# gitignore template for Jupyter Notebooks |
||||
# website: http://jupyter.org/ |
||||
|
||||
.ipynb_checkpoints |
||||
*/.ipynb_checkpoints/* |
||||
|
||||
# IPython |
||||
profile_default/ |
||||
ipython_config.py |
||||
|
||||
# Remove previous ipynb_checkpoints |
||||
# git rm -r .ipynb_checkpoints/ |
||||
|
||||
### Python ### |
||||
# Byte-compiled / optimized / DLL files |
||||
__pycache__/ |
||||
*.py[cod] |
||||
*$py.class |
||||
|
||||
# C extensions |
||||
*.so |
||||
|
||||
# Distribution / packaging |
||||
.Python |
||||
build/ |
||||
develop-eggs/ |
||||
dist/ |
||||
downloads/ |
||||
eggs/ |
||||
.eggs/ |
||||
lib/ |
||||
lib64/ |
||||
parts/ |
||||
sdist/ |
||||
var/ |
||||
wheels/ |
||||
share/python-wheels/ |
||||
*.egg-info/ |
||||
.installed.cfg |
||||
*.egg |
||||
MANIFEST |
||||
|
||||
# PyInstaller |
||||
# Usually these files are written by a python script from a template |
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it. |
||||
*.manifest |
||||
*.spec |
||||
|
||||
# Installer logs |
||||
pip-log.txt |
||||
pip-delete-this-directory.txt |
||||
|
||||
# Unit test / coverage reports |
||||
htmlcov/ |
||||
.tox/ |
||||
.nox/ |
||||
.coverage |
||||
.coverage.* |
||||
.cache |
||||
nosetests.xml |
||||
coverage.xml |
||||
*.cover |
||||
*.py,cover |
||||
.hypothesis/ |
||||
.pytest_cache/ |
||||
cover/ |
||||
|
||||
# Translations |
||||
*.mo |
||||
*.pot |
||||
|
||||
# Django stuff: |
||||
*.log |
||||
local_settings.py |
||||
db.sqlite3 |
||||
db.sqlite3-journal |
||||
|
||||
# Flask stuff: |
||||
instance/ |
||||
.webassets-cache |
||||
|
||||
# Scrapy stuff: |
||||
.scrapy |
||||
|
||||
# Sphinx documentation |
||||
docs/_build/ |
||||
|
||||
# PyBuilder |
||||
.pybuilder/ |
||||
target/ |
||||
|
||||
# Jupyter Notebook |
||||
|
||||
# IPython |
||||
|
||||
# pyenv |
||||
# For a library or package, you might want to ignore these files since the code is |
||||
# intended to run in multiple environments; otherwise, check them in: |
||||
# .python-version |
||||
|
||||
# pipenv |
||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. |
||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies |
||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not |
||||
# install all needed dependencies. |
||||
#Pipfile.lock |
||||
|
||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow |
||||
__pypackages__/ |
||||
|
||||
# Celery stuff |
||||
celerybeat-schedule |
||||
celerybeat.pid |
||||
|
||||
# SageMath parsed files |
||||
*.sage.py |
||||
|
||||
# Environments |
||||
.env |
||||
.venv |
||||
env/ |
||||
venv/ |
||||
ENV/ |
||||
env.bak/ |
||||
venv.bak/ |
||||
|
||||
# Spyder project settings |
||||
.spyderproject |
||||
.spyproject |
||||
|
||||
# Rope project settings |
||||
.ropeproject |
||||
|
||||
# mkdocs documentation |
||||
/site |
||||
|
||||
# mypy |
||||
.mypy_cache/ |
||||
.dmypy.json |
||||
dmypy.json |
||||
|
||||
# Pyre type checker |
||||
.pyre/ |
||||
|
||||
# pytype static type analyzer |
||||
.pytype/ |
||||
|
||||
# Cython debug symbols |
||||
cython_debug/ |
||||
|
||||
# End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks |
@ -0,0 +1,9 @@
|
||||
Template for the Read the Docs tutorial |
||||
======================================= |
||||
|
||||
This GitHub template includes fictional Python library |
||||
with some basic Sphinx docs. |
||||
|
||||
Read the tutorial here: |
||||
|
||||
https://docs.readthedocs.io/en/stable/tutorial/ |
@ -0,0 +1,20 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help: |
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile |
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile |
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
@ -0,0 +1,35 @@
|
||||
@ECHO OFF |
||||
|
||||
pushd %~dp0 |
||||
|
||||
REM Command file for Sphinx documentation |
||||
|
||||
if "%SPHINXBUILD%" == "" ( |
||||
set SPHINXBUILD=sphinx-build |
||||
) |
||||
set SOURCEDIR=source |
||||
set BUILDDIR=build |
||||
|
||||
if "%1" == "" goto help |
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL |
||||
if errorlevel 9009 ( |
||||
echo. |
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx |
||||
echo.installed, then set the SPHINXBUILD environment variable to point |
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you |
||||
echo.may add the Sphinx directory to PATH. |
||||
echo. |
||||
echo.If you don't have Sphinx installed, grab it from |
||||
echo.http://sphinx-doc.org/ |
||||
exit /b 1 |
||||
) |
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% |
||||
goto end |
||||
|
||||
:help |
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% |
||||
|
||||
:end |
||||
popd |
@ -0,0 +1,7 @@
|
||||
API |
||||
=== |
||||
|
||||
.. autosummary:: |
||||
:toctree: generated |
||||
|
||||
lumache |
@ -0,0 +1,35 @@
|
||||
# Configuration file for the Sphinx documentation builder. |
||||
|
||||
# -- Project information |
||||
|
||||
project = 'Lumache' |
||||
copyright = '2021, Graziella' |
||||
author = 'Graziella' |
||||
|
||||
release = '0.1' |
||||
version = '0.1.0' |
||||
|
||||
# -- General configuration |
||||
|
||||
extensions = [ |
||||
'sphinx.ext.duration', |
||||
'sphinx.ext.doctest', |
||||
'sphinx.ext.autodoc', |
||||
'sphinx.ext.autosummary', |
||||
'sphinx.ext.intersphinx', |
||||
] |
||||
|
||||
intersphinx_mapping = { |
||||
'python': ('https://docs.python.org/3/', None), |
||||
'sphinx': ('https://www.sphinx-doc.org/en/master/', None), |
||||
} |
||||
intersphinx_disabled_domains = ['std'] |
||||
|
||||
templates_path = ['_templates'] |
||||
|
||||
# -- Options for HTML output |
||||
|
||||
html_theme = 'sphinx_rtd_theme' |
||||
|
||||
# -- Options for EPUB output |
||||
epub_show_urls = 'footnote' |
@ -0,0 +1,22 @@
|
||||
Welcome to Lumache's documentation! |
||||
=================================== |
||||
|
||||
**Lumache** (/lu'make/) is a Python library for cooks and food lovers |
||||
that creates recipes mixing random ingredients. |
||||
It pulls data from the `Open Food Facts database <https://world.openfoodfacts.org/>`_ |
||||
and offers a *simple* and *intuitive* API. |
||||
|
||||
Check out the :doc:`usage` section for further information, including |
||||
how to :ref:`installation` the project. |
||||
|
||||
.. note:: |
||||
|
||||
This project is under active development. |
||||
|
||||
Contents |
||||
-------- |
||||
|
||||
.. toctree:: |
||||
|
||||
usage |
||||
api |
@ -0,0 +1,34 @@
|
||||
Usage |
||||
===== |
||||
|
||||
.. _installation: |
||||
|
||||
Installation |
||||
------------ |
||||
|
||||
To use Lumache, first install it using pip: |
||||
|
||||
.. code-block:: console |
||||
|
||||
(.venv) $ pip install lumache |
||||
|
||||
Creating recipes |
||||
---------------- |
||||
|
||||
To retrieve a list of random ingredients, |
||||
you can use the ``lumache.get_random_ingredients()`` function: |
||||
|
||||
.. autofunction:: lumache.get_random_ingredients |
||||
|
||||
The ``kind`` parameter should be either ``"meat"``, ``"fish"``, |
||||
or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients` |
||||
will raise an exception. |
||||
|
||||
.. autoexception:: lumache.InvalidKindError |
||||
|
||||
For example: |
||||
|
||||
>>> import lumache |
||||
>>> lumache.get_random_ingredients() |
||||
['shells', 'gorgonzola', 'parsley'] |
||||
|
@ -0,0 +1,23 @@
|
||||
""" |
||||
Lumache - Python library for cooks and food lovers. |
||||
""" |
||||
|
||||
__version__ = "0.1.0" |
||||
|
||||
|
||||
class InvalidKindError(Exception): |
||||
"""Raised if the kind is invalid.""" |
||||
pass |
||||
|
||||
|
||||
def get_random_ingredients(kind=None): |
||||
""" |
||||
Return a list of random ingredients as strings. |
||||
|
||||
:param kind: Optional "kind" of ingredients. |
||||
:type kind: list[str] or None |
||||
:raise lumache.InvalidKindError: If the kind is invalid. |
||||
:return: The ingredients list. |
||||
:rtype: list[str] |
||||
""" |
||||
return ["shells", "gorgonzola", "parsley"] |
Loading…
Reference in new issue