Skip to content

Latest commit

 

History

History
84 lines (71 loc) · 1.95 KB

File metadata and controls

84 lines (71 loc) · 1.95 KB

Usage Examples

Hello, Cookie!

Using Cookie is very easy. Here is a simple hello world function.

def hello (string=None):
    print("Hello, " + string + "!")
    
if __name__ == "__main__":
    hello()

to turn it into a command line app with cookie, add the following above the function:

from cookie import Cookie

app = Cookie(__name__)

@app.cookie
...

no we can easily run this from the command line.

python hello_cookie.py --name kaleb

Hello, Kaleb!
My name is Cookie!

you can also just use -n for simplicity. Cookie automatically generates help pages as well.

python hello_cookie.py --help 

Usage: hello_cookie.py [-n NAME | --name NAME]
   		       [ -h | --help ]

Getting a list of arguments!

TODO

Packaging your app!

Cookie is designed to be scalable and contained. For this reason, the packaging process is very very simple. Go ahead and create a folder structure similar to this around your cookie app.

cookie-app/
	app/
	|-------hello_cookie.py
	|-------__init__.py
	
	tests/
	|-------test.py
	
	AUTHORS
	requires.txt
	setup.py

The most important file here is requires.txt. This will tell the end user of your app what the dependencies are. This file should look something like this.

cookie
example-package1
example-package2

The second most important file is setup.py. This will make your project installable. This file should look someting like this.

from setuptools import setup

setup(
    name='cookie-app',
    version='0.1dev',
    author='your name here',
    url='link to github repo',
    packages=['app'],
    test_suite='tests.test',
    license='BSD')

After you have completed the above, go ahead and make your own test in tests/test.py. Now that your structure is complete, put your package on github.

Here is a perfect example of a cookie app.