ptyx-mcq


Nameptyx-mcq JSON
Version 28.0.0 PyPI version JSON
download
home_pagehttps://github.com/wxgeo/ptyx
SummarypTyX-MCQ is a generator/scanner of MCQ, based on pTyX.
upload_time2024-11-05 15:31:55
maintainerNone
docs_urlNone
authorNicolas Pourcelot
requires_python<4.0,>=3.10
licenseGPL-3.0-or-later
keywords python tikz latex pdf exam mcq student
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            pTyX MCQ Extension
==================

MCQ generation (PDF files) and automatic marking of scanned students answers.

Overview
--------
pTyX is a LaTeX precompiler, written in Python.
pTyX enables to generate LaTeX documents, using custom commands or plain python code.
One single pTyX file may generate many latex documents, with different values.
I developed and used pTyX to make several versions of a same test in exams,
for my student, to discourage cheating.
Since it uses sympy library, pTyX has symbolic calculus abilities too.

The `pTyX MCQ extension` makes it easy to use pTyX to generate Multiple Choice Questions 
in the form of pdf documents.
The students MCQ can then be scanned and automatically corrected and marked.

Installation
------------

Obviously, pTyX needs a working Python installation.
Python version 3.8 (at least) is required for pTyX MCQ to run.

Currently, pTyX is only supported on GNU/Linux.

The easiest way to install it is to use pip.

    $ pip install --user ptyx_mcq

Usage
-----

To generate a template, run:

    $ mcq new new_folder

This will generate a `new_folder` folder with a `new.ptyx` file inside,
which is the main configuration file.

This will also create a `new_folder/questions/` folder, where you should put all the exercises, 
as `.txt` files. 

A few text files are already included as examples.

See the next section (*MCQ file format*) for more information about those files format.

To compile the template, run:

    $ mcq make

For more options:

    $ mcq make --help

To automatically corrected the scanned students MCQs, but them as a pdf inside `new_folder/scan`.

Then run:
    
    $ mcq scan


MCQ file format
---------------

When running `mcq new`, a template folder will be generated, including a `new.ptyx` file.

(More to come...)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/wxgeo/ptyx",
    "name": "ptyx-mcq",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "python, tikz, latex, pdf, exam, mcq, student",
    "author": "Nicolas Pourcelot",
    "author_email": "nicolas.pourcelot@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/cc/93/24a39fd8cfba68fc36702bf69aaa5ca59c7933da1c1dfe540046cfac5f7b/ptyx_mcq-28.0.0.tar.gz",
    "platform": null,
    "description": "pTyX MCQ Extension\n==================\n\nMCQ generation (PDF files) and automatic marking of scanned students answers.\n\nOverview\n--------\npTyX is a LaTeX precompiler, written in Python.\npTyX enables to generate LaTeX documents, using custom commands or plain python code.\nOne single pTyX file may generate many latex documents, with different values.\nI developed and used pTyX to make several versions of a same test in exams,\nfor my student, to discourage cheating.\nSince it uses sympy library, pTyX has symbolic calculus abilities too.\n\nThe `pTyX MCQ extension` makes it easy to use pTyX to generate Multiple Choice Questions \nin the form of pdf documents.\nThe students MCQ can then be scanned and automatically corrected and marked.\n\nInstallation\n------------\n\nObviously, pTyX needs a working Python installation.\nPython version 3.8 (at least) is required for pTyX MCQ to run.\n\nCurrently, pTyX is only supported on GNU/Linux.\n\nThe easiest way to install it is to use pip.\n\n    $ pip install --user ptyx_mcq\n\nUsage\n-----\n\nTo generate a template, run:\n\n    $ mcq new new_folder\n\nThis will generate a `new_folder` folder with a `new.ptyx` file inside,\nwhich is the main configuration file.\n\nThis will also create a `new_folder/questions/` folder, where you should put all the exercises, \nas `.txt` files. \n\nA few text files are already included as examples.\n\nSee the next section (*MCQ file format*) for more information about those files format.\n\nTo compile the template, run:\n\n    $ mcq make\n\nFor more options:\n\n    $ mcq make --help\n\nTo automatically corrected the scanned students MCQs, but them as a pdf inside `new_folder/scan`.\n\nThen run:\n    \n    $ mcq scan\n\n\nMCQ file format\n---------------\n\nWhen running `mcq new`, a template folder will be generated, including a `new.ptyx` file.\n\n(More to come...)\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "pTyX-MCQ is a generator/scanner of MCQ, based on pTyX.",
    "version": "28.0.0",
    "project_urls": {
        "Homepage": "https://github.com/wxgeo/ptyx",
        "Repository": "https://github.com/wxgeo/ptyx"
    },
    "split_keywords": [
        "python",
        " tikz",
        " latex",
        " pdf",
        " exam",
        " mcq",
        " student"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "67428a5eb67f0aa4ee2e866bf2cec0e043e02d1806eb4a88235bb0d0714cf404",
                "md5": "50490d12ff12033186fbc3c801460af9",
                "sha256": "24c295b66f94fa93f8b11f34ca229c4d29462115af34a8842b86579bf088a7f1"
            },
            "downloads": -1,
            "filename": "ptyx_mcq-28.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "50490d12ff12033186fbc3c801460af9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 139589,
            "upload_time": "2024-11-05T15:31:53",
            "upload_time_iso_8601": "2024-11-05T15:31:53.582729Z",
            "url": "https://files.pythonhosted.org/packages/67/42/8a5eb67f0aa4ee2e866bf2cec0e043e02d1806eb4a88235bb0d0714cf404/ptyx_mcq-28.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cc9324a39fd8cfba68fc36702bf69aaa5ca59c7933da1c1dfe540046cfac5f7b",
                "md5": "da9701b4aaf01f753176fe46bafe9ce7",
                "sha256": "eda186d75b2fb7729a66bce096178608b11671ba27c3fc8354236bf8cc9590c0"
            },
            "downloads": -1,
            "filename": "ptyx_mcq-28.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "da9701b4aaf01f753176fe46bafe9ce7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 119237,
            "upload_time": "2024-11-05T15:31:55",
            "upload_time_iso_8601": "2024-11-05T15:31:55.681148Z",
            "url": "https://files.pythonhosted.org/packages/cc/93/24a39fd8cfba68fc36702bf69aaa5ca59c7933da1c1dfe540046cfac5f7b/ptyx_mcq-28.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-05 15:31:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "wxgeo",
    "github_project": "ptyx",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "ptyx-mcq"
}
        
Elapsed time: 0.41700s