https://github.com/evz/tacofancy-api

Making an API for https://github.com/sinker/tacofancy
https://github.com/evz/tacofancy-api

Last synced: about 1 month ago
JSON representation

Making an API for https://github.com/sinker/tacofancy

• Host: GitHub
• URL: https://github.com/evz/tacofancy-api
• Owner: evz
• License: mit
• Created: 2013-11-05T06:03:45.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2023-04-04T21:38:00.000Z (over 1 year ago)
• Last Synced: 2024-08-01T21:54:45.409Z (4 months ago)
• Language: Python
• Size: 452 KB
• Stars: 123
• Watchers: 6
• Forks: 31
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-food - tacofancy-api - An API for the repo Tacofancy. (API for Food services)

README

        
# TacoFancy API

Making an API for https://github.com/sinker/tacofancy

### Main endpoint

The main endpoint for the API exists at: 

http://taco-randomizer.herokuapp.com/

Visiting that page will also get you a random taco.

### Use this data

If you’d like to take advantage of the API that was put together for this, I added

a CORS header to these paths so that you can load them from a javascript app 

anywhere on the internet.

##### Random Taco

Visiting:

``/random/``

will get you a random Base Layer, Mixin, Condiment, Seasoning and  Shell. To

just get a random full taco recipe, call it thusly:

``/random/?full-taco=true``

##### Contributors

If you’d like to get info about the contributors for a certain recipe,

you can call this endpoint:

``/contributors/:recipe_type/:recipe_slug/``

So to get the contributors for the Delengua (Beef Tounge) Base Layer, do this:

``/contributors/base_layers/delengua_beef_tongue``

Valid layer types are: ``base_layers``, ``mixins``, ``seasonings``, ``condiments``

and ``shells``. To get a mapping of slugs for a given recipe type call this:

``/contributors/:recipe_type/``

##### Contributions

If you’d like to see who has made what contributions to which recipes, call this:

``/contributions/:github_username/``

So, to get all of [Dan Sinker’s](http://github.com/sinker) contributions, call this:

``/contributions/sinker/``

To get a listing of all contributors and their usernames, call:

``/contributions/``

### Want to help?

This whole this is a relatively rudimentary Flask setup. After you ``pip install``

the requirements, you should be able to visit ``/cook/`` to get a DB

together. The Flask app is looking for an environmental variable ``DATABASE_URL`` to

tell it how to connect to the database. Depending on what backend you’re using, you

might need to actually create the database, etc before it’ll work.

I developed this with sqlite but you should be able to use any backend that

SQLAlchemy supports. 

You’ll also need to set ``GITHUB_TOKEN`` as an environment variable. This is a

OAuth Token for the Github API. You can read more about how to get that going

[here](https://developer.github.com/v3/auth/#basic-authentication)