{"id":13595423,"url":"https://github.com/atiumcache/pure-recipe","last_synced_at":"2025-04-09T13:31:55.053Z","repository":{"id":209371716,"uuid":"723863925","full_name":"atiumcache/pure-recipe","owner":"atiumcache","description":"Input a recipe URL and receive well-formatted, ad-free recipes to your terminal, or save the output to a markdown file. ","archived":false,"fork":false,"pushed_at":"2024-05-09T13:22:33.000Z","size":646,"stargazers_count":59,"open_issues_count":2,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-09T14:55:04.030Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atiumcache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-26T23:20:02.000Z","updated_at":"2024-06-01T21:39:27.469Z","dependencies_parsed_at":"2024-06-01T21:55:23.375Z","dependency_job_id":null,"html_url":"https://github.com/atiumcache/pure-recipe","commit_stats":null,"previous_names":["atiumcache/pure-recipe"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atiumcache%2Fpure-recipe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atiumcache%2Fpure-recipe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atiumcache%2Fpure-recipe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atiumcache%2Fpure-recipe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atiumcache","download_url":"https://codeload.github.com/atiumcache/pure-recipe/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248049327,"owners_count":21039204,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T16:01:49.714Z","updated_at":"2025-04-09T13:31:54.731Z","avatar_url":"https://github.com/atiumcache.png","language":"Python","funding_links":[],"categories":["others","\u003ca name=\"online\"\u003e\u003c/a\u003eOnline search and resources","Python"],"sub_categories":[],"readme":"# Pure Recipe\n### A web-to-markdown recipe viewer.\n\nWe're tired of the ads. We're tired of the blog posts. We just want the recipe!\n\nThis is a terminal application that allows you to quickly bypass the junk that plagues most recipe websites. Just run the program and _voilà_, a pretty-printed recipe is outputted to your terminal. Alternatively, you can save the recipe to a markdown file for later use.\n\n- [Installation](#installation)\n- [Usage](#usage)\n\t- [View in Terminal](#view-in-terminal)\n\t- [Save to Markdown](#save-to-markdown)\n\t- [Save a List of URLs](#save-a-list-of-urls)\n\t- [Browse](#browse)\n- [Configuration](#configuration)\n\t- [Config Template](#config-template)\n- [Supported Websites](#supported-websites)\n- [Why Create Pure Recipe?](#why-create-pure-recipe)\n- [Future Work](#future-work)\n- [License](#license)\n\n## Features\n\n- View recipes directly in your terminal.\n- Save recipes to markdown for easy access and sharing.\n- Support for a wide range of cooking sites.\n- Easy-to-use command-line interface.\n\n## Installation\n\n**Prerequisites:**\n\n- Python 3.6 or higher.\n\n**Steps:**\n\n1. Clone the repository or download `pure_recipe.py` and `requirements.txt`.\n2. Install the required Python dependencies:\n\t\n \t\tpip install -r requirements.txt\n\n\n## Usage\n\nThere are four options: `view`, `save`, `list`, or `browse`. \n\n### View in Terminal\n\n**Command:**\n\n\tpython pure_recipe.py view [RECIPE_URL]\n\n**Example:**\n\n\tpython pure_recipe.py view https://www.seriouseats.com/potato-wedges-recipe-5217319\n\nViewing example:\n\n![terminal demonstration](gifs/pure-recipe.gif)\n\n### Save to Markdown\n\n**Command:**\n\n\tpython pure_recipe.py save [RECIPE_URL]\n\n**Example:**\n\n\tpython pure_recipe.py save https://www.seriouseats.com/potato-wedges-recipe-5217319\n\nSaves a recipe from a given URL. The default save location is `/home/user/Documents/recipes/`. Change this path in the `config.yaml` file, as described below. \n\n### Save a List of URLs\n\n**Command:**\n\n\tpython pure_recipe.py list [FILE_PATH]\n\nHave a whole bunch of recipes that you want to save? Just create a `.txt` file with one recipe on each line. Make sure the file is located in your `recipe` directory denoted in your `config` file. Default location is `/home/user/Documents/recipes/`.\n\nConsider an example file called `recipes_list.txt`:\n\n\thttps://www.seriouseats.com/beef-braciole-recipe-7561806\n\thttps://www.seriouseats.com/basque-cheesecake\n\thttps://www.seriouseats.com/omelette-souffle-with-cheese\n\nThen, run the program as follows:\n\n\tpython pure_recipe.py list recipes_list.txt\n\nYou should see all recipes on the list saved in markdown format.\n\nThe default location is `/home/user/Documents/recipes/`. Change this path in the `config.yaml` file, as described below. \n\n### Browse\n\n**Command:**\n\n\tpython pure_recipe.py browse\n \nBrowse and view your saved recipes.\n\n## Configuration\n\nThe program will create a `config.yaml` file upon its first run. The program should create default settings, placing a `recipe` directory in the user's `Documents` directory.\n\nIf needed, copy and paste the following template into the config file, changing the path to a folder where you want your recipes saved. \n\n### Config Template\n\n\t---\n\tdirectory: '/path/to/your/recipes/'\n\ttime: true\n\tyield: true\n\n- `directory`: Path where your recipes are saved.\n- `time`: Include preparation and cooking time in the output.\n- `yield`: Include the number of servings.\n\nMore settings are planned for the future.\n\n## Supported Websites\n\nCheck out the [list of supported websites](https://github.com/hhursev/recipe-scrapers#scrapers-available-for) for recipe scraping.\n\n## Troubleshooting\n\n- Dependency Issues: Ensure all dependencies are correctly installed.\n- Invalid URLs: Check the URL format and website support.\n- File Permissions: Ensure you have write permissions to the specified recipe directory.\n\n## Why Create Pure Recipe?\n\nThere does exist other solutions for bypassing ad-filled recipes --- namely, Paprika. However, you are locked into their ecosystem and exporting the recipes can be troublesome. Plus, there is a subscription fee to use the app on multiple ecosystems/devices. \n\nWith Pure Recipe, you can be in charge of your own digital recipe book. By saving the files in Markdown format, you can quickly transfer recipes to a new device. Or, share your well-formatted recipes with family and friends without forcing them to download a propietary app. \n\n## Future Work\n\n- Adding more robust error handling.\n- Implementing unit tests for reliability.\n- Introducing different color themes.\n- ~~Ability to pass in a list of URLs to save, all at once.~~\n- Searching for recipes directly from the terminal.\n- ~~Browse your saved-recipes folder in the terminal.~~\n\n## Contributing\n\nContributions are welcome! If you have a suggestion or want to contribute code, please feel free to make a pull request or open an issue.\n\n## License\n\nDistributed under the MIT License. See LICENSE.txt for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatiumcache%2Fpure-recipe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatiumcache%2Fpure-recipe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatiumcache%2Fpure-recipe/lists"}