Skip to main content

User's knowledge verificator

Project description

Knowledge Verificator

Main CI pipeline

Knowledge Verificator is a tool for self-learning. It employs Natural Language Processing (NLP) techniques to facilitate and increase effectiveness of self-study. The project has been created as the Bachelor's Thesis of Igor Sosnowicz.

Using Knowledge Verificator is simple. Step by step:

  1. Insert a paragraph you want to teach yourself or choose something from a databaset of predefined ones.
  2. Knowledge Verificator generates a question for you.
  3. You answer the question.
  4. Your question is evaluated and you get the feedback.
  5. The process repeats as long as you like.

Installation

Install with pipx

If you have pipx already installed, use:

pipx install knowledge-verificator

Install with pip

If you have pip already installed, use:

pip install knowledge-verificator

Usage

Run with pipx

If you have installed with pipx, run with:

pipx run knowledge-verificator

Run with pip

If you have installed with pip, run with:

python -m knowledge_verificator

Development

Prerequisites

You have to have the following tools installed:

  • build and dependency management system: poetry
  • npm - javascript package manager

Steps

Backend

  1. Clone the repository.

    git clone git@github.com:Iamhexi/knowledge_verificator.git
    
  2. Enter its directory.

    cd knowledge_verificator
    
  3. Install all dependencies, also including the optional ones.

    poetry install --with test
    

As a one-liner:

git clone git@github.com:Iamhexi/knowledge_verificator.git && cd knowledge_verificator && poetry install --with test

Frontend

  1. Change directory to frontend.

    cd frontend
    
  2. Install the modules required by the frontend.

    npm install
    

As a one-liner:

cd frontend && npm install

And then run the application (make sure you are in the root directory of the repository).

poetry run python knowledge_verificator/main.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

knowledge_verificator-0.1.3.tar.gz (29.5 kB view details)

Uploaded Source

Built Distribution

knowledge_verificator-0.1.3-py3-none-any.whl (34.3 kB view details)

Uploaded Python 3

File details

Details for the file knowledge_verificator-0.1.3.tar.gz.

File metadata

  • Download URL: knowledge_verificator-0.1.3.tar.gz
  • Upload date:
  • Size: 29.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.7 Linux/6.11.5-arch1-1

File hashes

Hashes for knowledge_verificator-0.1.3.tar.gz
Algorithm Hash digest
SHA256 0ff2b3e6a00e894994e5a1f6844972a72840a1fc2a946e78bc59bbdacd5b3c15
MD5 00c8557123ffebdda68ccd7449dbd69d
BLAKE2b-256 1c18988f76f86573af87a420e93f3d303b459b8c49025054f20dbd1eec4e94ae

See more details on using hashes here.

File details

Details for the file knowledge_verificator-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for knowledge_verificator-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a0f35072bcdcb3db1fc37fcf323537ab53b2414776a15473324eb09861f6c4e4
MD5 58a0939506cecb58eabc59db3111e6a9
BLAKE2b-256 dc1e83027e45701c62138185786e5d3fb37a780ccb4ac24c6a010e7c697290eb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page