Skip to content

Commit

Permalink
Merge pull request #14 from clvrk/dev
Browse files Browse the repository at this point in the history
Docs
  • Loading branch information
firstaidguyheru authored Apr 12, 2021
2 parents f2e3af5 + 5694874 commit e504186
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 0 deletions.
21 changes: 21 additions & 0 deletions Docs.md
Original file line number Diff line number Diff line change
@@ -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).
1 change: 1 addition & 0 deletions cocktaildb/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from cocktaildb import search, categories, ingredients, glasses
33 changes: 33 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -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="[email protected]",
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',
},
)

0 comments on commit e504186

Please sign in to comment.