https://github.com/billbrod/cocktails

Static site for viewing cocktails

https://github.com/billbrod/cocktails

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.7%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Static site for viewing cocktails

Basic Info
  • Host: GitHub
  • Owner: billbrod
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Size: 96.7 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Created over 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License

README.md

cocktails

Static site for viewing cocktails

TODO: - simple syrup and recipe pages, ignore others - scale up, price out - create "events pages" with certain recipes: I think just have events in tags - have page mapping generic spirits to brands - allow recipes to specify generic spirits or lists of spirits (with default) - public and private recipes (with tags)

Comments: can use utterances, but any of the "bot automatically creates issue" options for how to match issue and page will have the bot post the link to the specific page, which defeats the purpose of having the site behind the password. works fine if we create issues, but then if issue doesn't exist, the comment thing just doesn't load, so we'd need to manually create issues for every page. could probably do that using github api but ... doesn't seem ideal.

looking on the issues, it looks like it's possible to get it working with a private repo, but then the bot and everyone who wants to post needs to be added as contributors (so one extra step involved).

To use

This repo has several python scripts which are used to grab data from Sheets and format it before building the website. To use, install dependencies found in scripts/requirements.txt.

download_csv.py and convert_old_csv.py are only used to get the data into the proper format and don't need to be run regularly, while write_markdown.py is used to get the data ready for the website and so needs to be run everytime the site is built.

  • scripts/download_csv.py: downloads all sheets from specified Google Spreadsheet as csvs in a single directory.
    • This accepts the spreadsheet ID and path to the credentials json file as inputs
    • spreadsheet_id can be found in the url of the google spreadsheet, between /d/ and /edit
    • For how to create the credentials file of a service account and give them access, see first two steps of: https://github.com/marketplace/actions/gsheet-action#setup-of-credentials
  • scripts/convert_old_csv.py: convert old csvs (as created by download_csv.py) into new format and upload them to a new spreadsheet.
    • Getting this to run on the outputs of the above required some manual editing.
    • Each csv file has a sheet_title field; we will clear any sheet found with this name in the target spreadsheet and then write the new contents.
    • This accepts the spreadsheet ID and path to the credentials json file as inputs. Note that the spreadsheet ID should be to a different sheet than download_csv.py!
    • spreadsheet_id can be found in the url of the google spreadsheet, between /d/ and /edit
    • For how to create the credentials file of a service account and give them access, see first two steps of: https://github.com/marketplace/actions/gsheet-action#setup-of-credentials
  • scripts/write_markdown.py: download all sheets from Google Spreadsheet as markdown files in a single directory. Unlike download_csv.py, this makes assumptions about how they're formatted.
    • This accepts the spreadsheet ID and path to the credentials json file as inputs. The spreadsheet ID should be the same as from convet_old_csv.py
    • spreadsheet_id can be found in the url of the google spreadsheet, between /d/ and /edit
    • For how to create the credentials file of a service account and give them access, see first two steps of: https://github.com/marketplace/actions/gsheet-action#setup-of-credentials

Owner

  • Name: William F. Broderick
  • Login: billbrod
  • Kind: user
  • Location: New York, NY
  • Company: Flatiron Institute

Associate data scientist at Flatiron Institute, working to make computational neuroscience more open, cumulative, and reproducible.

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • utterances-bot (1)
  • billbrod (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

scripts/requirements.txt pypi
  • click *
  • google-api-python-client *
  • google-auth *
  • google-auth-httplib2 *
  • pandas *