Mother Tongues Dictionaries (MTD)
This repo is under construction and could change drastically in the coming months with breaking changes.
MTD is the first of two open-source tools that allow language communities and developers to quickly and inexpensively make their dictionary data digitally accessible. MTD is a tool that parses and prepares your data for being used with an MTD UI.
Please visit the website or docs for more information.
Table of Contents
Background
This project started as just a single dictionary for Gitxsan - a language spoken in Northern British Columbia, but it became quickly apparent that many communities also had the same problem. That is, they had some dictionary data but all of the options for sharing that data online were prohibitively expensive. MTD aims to make it easier to create online digital dictionary resources.
Note - Just because you can make an online dictionary does not mean you should. Before making a dictionary, you must have clear consent from the language community in order to publish a dictionary. For some background on why this is important, please read sections 1 and 2.1 here
Install
It is recommended to install mothertongues using pip. The package name is mothertongues, but it is imported as mtd and the CLI can be run using either mothertongues or mtd.
pip install mothertongues
Usage
In order to create a Mother Tongues Dictionary you will need at least two things:
- A configuration file for you language/dictionary
- A configuration file for each source of data
You can find out more about how to create these files against the MTD configuration schema by visiting the docs
Once you have those files, you can either create a dictionary programatically or using the command line interface.
Using Python directly
from mtd import create_dictionary
dictionary = create_dictionary(PATH_TO_LANGUAGE_CONFIG)
# write a file containing configuration information
config_js = dictionary.return_formatted_config(form='js')
with open('config.js', 'w', encoding='utf8') as f:
f.write(config_js)
# write a file containing lexical data
dict_cached_js = dictionary.return_formatted_data(form='js')
with open('dict_cached.js', 'w', encoding='utf8') as f:
f.write(dict_cached_js)
The two files that are then created above (config.js and dict_cached.js) can be dropped into any MTD-UI to build a dictionary.
Using the CLI
You can either export your dictionary as a static site:
mtd export <PATH_TO_LANGUAGE_CONFIG> web <OUTPUT_DIR>
Or, you can build it first:
mtd prepare <PATH_TO_LANGUAGE_CONFIG>
And then serve it locally:
mtd run
Contributing
If something is not working, or you'd like to see another feature added, feel free to dive in! Open an issue or submit PRs. Help writing and clarifying documentation is also very welcome.
This repo follows the Contributor Covenant Code of Conduct.
Acknowledgements
Thank you to both Patrick Littell & Mark Turin for their contributions, guidance and support as well as institutional support from the First Peoples' Cultural Council and SSHRC Insight Grant 435-2016-1694, ‘Enhancing Lexical Resources for BC First Nations Languages’.
Thank you to all other contributors for support with improving MotherTongues, finding bugs and writing documentation.
Contributors
This project exists thanks to all the people who contribute.
@littell. @markturin. @eddieantonio. @kavonjon.
License
1 maintainer
Metadata
1 maintainer
Release files for mothertongues 0.15.20191109
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mothertongues-0.15.20191109.tar.gz | 1.9 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mothertongues-0.15.20191109-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.6 MB
Release files / mothertongues-0.15.20191109.tar.gz
| Download URL | mothertongues-0.15.20191109.tar.gz |
|---|---|
| Size | 1.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8bc6f29db202d153cc72d45ee02e5c9e0425a16171e30d3b92d49927cf874d0d
|
|
BLAKE2b-256 checksum How to use checksums |
ea448bea4607400bb608ac30a626c987e44cca936761a3a61200eea68943c768
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.31.1 CPython/3.7.4
|
Release files / mothertongues-0.15.20191109-py3-none-any.whl
| Download URL | mothertongues-0.15.20191109-py3-none-any.whl |
|---|---|
| Size | 6.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fe9d6df55cf124b003400969ced618de8fd6352f2c8bead0516a1e497649b5cd
|
|
BLAKE2b-256 checksum How to use checksums |
167b501ee2f4206954a88a1bf52d51319b066bd63053a00e4e5264418f4f5448
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.31.1 CPython/3.7.4
|
