https://github.com/ephes/kptncook
Fetch receipts from kptncook API and export them to mealie or paprika
https://github.com/ephes/kptncook
cooking mealie paprika receipts
Last synced: 6 months ago
JSON representation
Fetch receipts from kptncook API and export them to mealie or paprika
- Host: GitHub
- URL: https://github.com/ephes/kptncook
- Owner: ephes
- License: mit
- Created: 2022-03-28T07:38:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-30T08:19:19.000Z (11 months ago)
- Last Synced: 2024-12-24T12:54:12.141Z (10 months ago)
- Topics: cooking, mealie, paprika, receipts
- Language: Jupyter Notebook
- Homepage:
- Size: 203 KB
- Stars: 43
- Watchers: 9
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# KptnCook
A small command line client for downloading [KptnCook](https://www.kptncook.com/) recipes. Atm it's only possible to download the three
recipes for today. If you know how to get the data for other days/oids
of recipes, please let me know :).
Thanks to [this blogpost](https://medium.com/analytics-vidhya/reversing-and-analyzing-the-cooking-app-kptncook-my-recipe-collection-5b5b04e5a085) for the url to get the json for today's recipes.
It's in pre alpha status and currently slightly unmaintained. If you want to step in, please let me know.
# Dependencies
* Python >=3.10
* Mealie >=v1.0
# Installation
```shell
$ pipx install kptncook
```
# Usage
## help
```shell
Usage: kptncook [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion [bash|zsh|fish|powershell|pwsh]
Install completion for the specified
shell.
--show-completion [bash|zsh|fish|powershell|pwsh]
Show completion for the specified shell,
to copy it or customize the installation.
--help Show this message and exit.
Commands:
backup-favorites Store kptncook favorites in local repository.
kptncook-access-token Get access token for kptncook.
kptncook-today List all recipes for today from the kptncook...
list-recipes List all locally saved recipes.
save-todays-recipes Save recipes for today from kptncook site.
search-by-id Search for a recipe by id in kptncook api, id...
sync Fetch recipes for today from api, save them to...
sync-with-mealie Sync locally saved recipes with mealie.
export-recipes-to-paprika Export a recipe by id or all recipes to Paprika app
```
## Environment
Set environment variables via `~/.kptncook/.env` dotenv file or directly in your shell. You'll need to set at least the `KPTNCOOK_API_KEY` variable. If you want to sync the recipes with mealie, you also have to set some additional variables.
If you want to back up your favorite receipts from KptnCook, you have to set the `KPTNCOOK_ACCESS_TOKEN` variable as well. You can obtain the access token by running the `kptncook kptncook-access_token` command. But you need a kptncook account to do that.
Beware: If you don't have a kptncook account, you'll lose all your favorites by creating a new one.
Here's an example:
```shell
KPTNCOOK_API_KEY=6q7QNKy-oIgk-IMuWisJ-jfN7s6
KPTNCOOK_ACCESS_TOKEN=9353xxxx-xxxx-4fe1-xxxx-xxx4a173805 # replace with correct token
MEALIE_URL=https://mealie.staging.django-cast.com/api
MEALIE_USERNAME=jochen
MEALIE_PASSWORD=password # replace with correct password
```
# Contribute
## Install Development Version
- Checkout source repository
- Create a virtualenv
Inside the virtualenv install flit (not via pipx!):
```shell
$ python -m pip install flit
```
Install a symlinked development version of the package:
```
$ flit install -s
```
Install the git pre-commit hooks:
```
$ pre-commit install
```
## Run Tests
Flit should have already installed pytest:
```shell
$ pytest
```
## Publish a Release
After running the tests, run `flit publish` to publish the package to PyPI.
```shell
$ flit publish
```