https://github.com/jeremyagray/vocutil

https://github.com/jeremyagray/vocutil

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jeremyagray/vocutil
• Owner: jeremyagray
• License: gpl-3.0
• Created: 2022-11-03T00:03:16.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-19T00:14:49.000Z (10 months ago)
• Last Synced: 2024-11-28T18:41:59.732Z (about 1 month ago)
• Language: Python
• Size: 262 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.rst

Awesome Lists containing this project

README

        
.. *****************************************************************************

..

.. vocutil, educational vocabulary utilities.

..

.. Copyright 2022-2024 Jeremy A Gray .

..

.. All rights reserved.

..

.. SPDX-License-Identifier: GPL-3.0-or-later

..

.. *****************************************************************************

vocutil

=======

Vocabulary utilities for educators and education platforms.

..

   .. image:: https://badge.fury.io/py/vocutil.svg

      :target: https://badge.fury.io/py/vocutil

      :alt: PyPI Version

   .. image:: https://readthedocs.org/projects/vocutil/badge/?version=latest

      :target: https://vocutil.readthedocs.io/en/latest/?badge=latest

      :alt: Documentation Status

Description

-----------

This is a collection of utilities useful for generating and

manipulating vocabulary lists (words and definitions) for educational

use.

Installation

------------

Install vocutil with::

  pip install vocutil

or add as a poetry dependency.

If you desire a package locally built with poetry, download the

source, change the appropriate lines in ``pyproject.toml``, and

rebuild.

JSON Data Format

----------------

All glossary data is stored in a master JSON file with the following format::

  {

    "course": {

      "title": string

    },

    "book": {

      "title": string,

      "author": string

    },

    "glossary": [

      {

        "word": string,

        "definition": string,

        "chapter": integer,

        "section": integer

      }

    ]

  }

Copyright and License

---------------------

SPDX-License-Identifier: `GPL-3.0-or-later `_

vocutil, educational vocabulary utilities.

Copyright (C) 2022-2024 `Jeremy A Gray `_.

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or (at

your option) any later version.

This program is distributed in the hope that it will be useful, but

WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see .

Author

------

`Jeremy A Gray `_