diff --git a/Docs.md b/Docs.md new file mode 100644 index 0000000..7dfc3b0 --- /dev/null +++ b/Docs.md @@ -0,0 +1,21 @@ +Usage of search function: +```python +import cocktaildb + +async def tequila_info(): + return await cocktaildb.search(query='tequila') +``` +Parameters include query, id, key, category, dict: bool, first_letter_only: bool, ingredient: bool, random: bool. +All of which default to either None or False. + +Lists of categories, ingredients etc. that may appear: +``` +import cocktaildb + +# This is in literally a list, not in the form of a dict or string +async def list_of_categories(): + return await cocktaildb.categories() +``` +There are more functions such as glasses() and ingredients(). + +This is a simple api wrapper that only supports free endpoints (for now atleast). diff --git a/cocktaildb/__init__.py b/cocktaildb/__init__.py new file mode 100644 index 0000000..21dd969 --- /dev/null +++ b/cocktaildb/__init__.py @@ -0,0 +1 @@ +from cocktaildb import search, categories, ingredients, glasses diff --git a/setup.py b/setup.py index e69de29..364f3c2 100644 --- a/setup.py +++ b/setup.py @@ -0,0 +1,33 @@ +import setuptools + +with open("requirements.txt", "r") as f: + requirements = f.readlines() + + +setuptools.setup ( + name='cocktail-wrapper', + author='clvrk', + author_email="herufromstatefarm@gmail.com", + url="https://github.com/clvrk/cocktail-wrapper", + version='1.0.0', + packages=['cocktaildb'], + python_requires=">= 3.6", + include_package_data=True, + install_requires=requirements, + description="An unofficial asynchronous API wrapper for thecocktaildb.com.", + long_description=None, + long_description_content_type="text/markdown", + keywords="api wrapper food cocktails asynchronous library free", + classifiers = ( + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", + "Natural Language :: English", + "Intended Audience :: Developers", + "Operating System :: OS Independent", + ), + project_urls = { + 'Funding': 'https://ko-fi.com/foodbot', + 'Support': 'https://discord.gg/csUnYsr', + 'Source': 'https://github.com/clvrk/cocktail-wrapper', + }, +)