Skip to main content

A Python package for parsing questions from pdf files.

Project description

Questions Parser

License: MIT PyPI version

This is a simple parser for questions about Java and OOP from PDF files.

Usage

  1. Install the package with
pip install QuestionsParser

or using GitHub installation:

pip install git+https://github.com/andylvua/QuestionsParser
  1. Parser usage example:
from QuestionsParser import QuestionsParser # import the parser class

parser = QuestionsParser("Questions.pdf") # create an instance of the parser and pass the PDF file with questions
answers = parser.parse_google() # parse the questions and get the answers from Google
answers.write_to_file("Answers.docx") # write the answers to a .docx file

Note

The parser uses Google to get the answers, so you need to have an active internet connection. The process of getting the answers can take a while, so be patient.

Options

The parser has several options that can be passed to the constructor and it's methods:

  • remainder_mod and questions_range parameters of QuestionsParser.

remainder_mod is a tuple of two integers, the remainder and the divisor respectively. For example, if remainder_mod = (2, 5), then the parser will parse only the questions with the remainder of 2 when divided by 5. Default value is (0, 1), which means that all questions will be parsed.

questions_range is a tuple of two integers, the first and the last questions respectively.

QuestionsParser(
    file_path: str,
    remainder_mod: tuple = (0, 1),
    questions_range: tuple = None,
)
  • parse_google method of QuestionsParser - autoparse_answers parameter. If set to False, parser will not parse the answers from Google, but will still provide the useful links instead. Default value is True.
QuestionsParser.parse_google(
    autoparse_answers: bool = True,
)
  • write_to_file method of QuestionsParser - path_to_file and header parameters. path_to_file is the path to the file where the answers will be written. header is the header of the file. Default value is Answers. This method couldn't be used before calling parse_google method.
QuestionsParser.write_to_file(
    path_to_file: str,
    header: str = "Answers",
)

Note

It's recommended to write the answers to a .docx file, as it provides better readability and is more convenient than a .pdf file. However, .pdf files are also supported.

Example

Here is an example of the output document:

image

License

The MIT License (MIT)

Copyright © 2022, Andrew Yaroshevych

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

QuestionsParser-1.0.1.tar.gz (7.5 kB view details)

Uploaded Source

File details

Details for the file QuestionsParser-1.0.1.tar.gz.

File metadata

  • Download URL: QuestionsParser-1.0.1.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.2

File hashes

Hashes for QuestionsParser-1.0.1.tar.gz
Algorithm Hash digest
SHA256 21ba352af6951f609d037249264b15b6642badb5f2a0687ecc5af8c532ac8f0b
MD5 f53fc936ec7215f04983563ef2fa8ebc
BLAKE2b-256 af5c6352f633658e00ad69f44d36aa47a9db411f01eaad75473181cf96ba4a99

See more details on using hashes here.

Supported by

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