Giter Club home page Giter Club logo

akinator-python's Introduction

Akinator-python

An API wrapper for the AkinatorAPI

>>pip install akinator-python<<

日本語は -> README_ja

Requirement

  • requests
  • bs4

Usage

Install this module, download example.py and run

example.py

from akinator_python import Akinator

akinator=Akinator(lang="en")
akinator.start_game()
while True:
    try:
        print(akinator.question)
        ans=input("answer:")
        if ans=="b":
            akinator.go_back()
        else:
            akinator.post_answer(ans)
            if akinator.answer_id:
                print(f"{akinator.name} / {akinator.description}")
                ans=input("is it correct?:")
                if ans=="n":
                    akinator.exclude()
                elif ans=="y":
                    break
                else:
                    break
    except Exception as e:
        print(e)
        continue

I have prepared a super simple example code
You can just run and enjoy it in terminal :)
0

Know a little more

Akinator()

  • You can set language, theme, child mode in arguments
  • language=str, The endpoint URL is determined based on this argument
    If nothing is specified, lang=jp Japanese will be selected
  • theme=str, characters or objects or animals
    If nothing is specified, theme=characters characters will be selected
  • child_mode=bool
    default is False

Akinator.start_game()

  • Start the Akinator game
    it will return a first question in str

Akinator.post_answer()

  • answer=str
    Answers are Yes : y No : n I don't know : idk probably : p probably not : pn

Akinator.go_back()

  • Yes, you can go back to the previous question

Akinator.exclude()

  • If Akinator's answer is incorrect, you can restart the question

Akinator.step

  • Always int, you can check the number of questions

Akinator.progression

  • Always float, progress of Akinator's "guess"

Akinator.question

  • Always str, just a question

When Akinator makes a guess

Akinator.name

  • Default is None, when it becomes available str, Character name guessed by Akinator

Akinator.description

  • Same as .name, Character description guessed by Akinator

Akinator.photo

  • Same as .name, photo URL in str Character photo guessed by Akinator

Supplement

.post_ansewer() .go_back() .exclude() are return a dict

Question in progress

{'completion': 'OK', 'akitude': 'serein.png', 'step': '1', 'progression': '0.00000',
 'question_id': '464', 'question': 'Is your character a girl?'}

When Akinator makes a guess

{'completion': 'OK', 'id_proposition': '309720', 'id_base_proposition': '10657795', 'valide_contrainte': '1',
 'name_proposition': 'Arihara Nanami', 'description_proposition': 'Riddle Joker', 
 'flag_photo': '2', 'photo': 'https://photos.clarinea.fr/BL_2_en/600/partenaire/p/10657795__894179331.png', 'pseudo': 'MrSand', 'nb_elements': 1}

Contacts

Discord server / https://discord.gg/aSyaAK7Ktm
Discord username / .taka.

akinator-python's People

Contributors

taka-4602 avatar

Stargazers

 avatar Medison avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.