Metadata-Version: 2.1
Name: gameyamlspiderandgenerator
Version: 2.0.0
Summary: A useful tool for generating Furrygameindex yaml files
Author: kaesinol
License: MIT
Requires-Python: <4.0,>=3.11
Requires-Dist: langcodes>=3.3.0
Requires-Dist: language-data>=1.1
Requires-Dist: html2text>=2020.1.16
Requires-Dist: ruamel-yaml>=0.17.21
Requires-Dist: ruamel-yaml-string>=0.1.0
Requires-Dist: urllib3>=1.26.14
Requires-Dist: beautifulsoup4>=4.11.1
Requires-Dist: pillow>=9.4.0
Requires-Dist: requests>=2.28.2
Requires-Dist: ruamel-base>=1.0.0
Requires-Dist: loguru>=0.7.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: pysocks>=1.7.1
Requires-Dist: lxml>=4.9.2
Requires-Dist: py3langid>=0.2.2
Requires-Dist: epicstore-api>=0.1.7
Requires-Dist: deepdiff>=7.0.1
Requires-Dist: FGI-YAML-Formattor>=0.1.0
Requires-Dist: yamlgenerator-hook-search<2.0,>=1.0.0a1
Requires-Dist: yamlgenerator-hook-validate<2.0,>=1.0.0a1
Description-Content-Type: text/markdown

![](https://github.com/FurryGamesIndex/GameYamlSpiderAndGenerator/actions/workflows/Test%20Default%20Hooks.yml/badge.svg)
![](https://github.com/FurryGamesIndex/GameYamlSpiderAndGenerator/actions/workflows/Test%20Main%20Program.yml/badge.svg)

# Quick Start

## Install

```commandline
pip install gameyamlspiderandgenerator -i https://pypi.org/simple
# install extra hook
# pip install yamlgenerator-hook-openai
python3.10
```

## Create a new configuration file

- config.yaml

```yaml
plugin:
  - steam
  - itchio
hook:
  - search
  - validate
# - openai
# if you don't want to set proxy, please fill in {}
proxy: { }
# http: socks5://127.0.0.1:7891
# https: socks5://127.0.0.1:7891
api:
  google-play: a714b00383f0662a61b2e382d55c685f17015617aa7048972da58a756fb75e90 # Get your api key via serpapi.com
  apple: a714b00383f0662a61b2e382d55c685f17015617aa7048972da58a756fb75e90
  openai: yourkey
  git_proxy: null # your git proxy website

```

## Try to make yaml data file

```bash
 python3.10 -m gameyamlspiderandgenerator -f /home/user/desktop/config.yaml  https://store.steampowered.com/app/290340/Armello/ -o 1.zip
 # or omit some options
 python3.10 -m gameyamlspiderandgenerator https://store.steampowered.com/app/290340/Armello/

```

*or use the library in your script*

```python
from gameyamlspiderandgenerator import produce_yaml
from gameyamlspiderandgenerator.util.config import config
from gameyamlspiderandgenerator.util.plugin_manager import pkg

config.load("/home/user/desktop/config.yaml")
pkg.init()
print(produce_yaml("https://store.steampowered.com/app/1470120/Atopes/"))
```

### More: see [API Reference](https://github.com/FurryGamesIndex/GameYamlSpiderAndGenerator/wiki/Api-Reference)
