Skip to main content

Mother Tongues Dictionaries (MTD)

Coverage Status Build Status Documentation Status PyPI package license standard-readme compliant

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 User Interface. Currently mobile and web are supported.

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 guides

Once you have those files, you can either create a dictionary using the command line interface.

The basic workflow for creating a dictionary is as follows:

  1. Fork and clone the mtd-starter
  2. Edit and prepare the repo using your own data
  3. Export your data to a format readable by the Mother Tongues User Interfaces
  4. Chose an interface, either mobile or web
  5. Add your exported data (config.js and dict_cached.js) from step 3 and then publish your dictionary! 🎉

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

AGPL-3 © Aidan Pine.

Metadata

Release files for mothertongues 0.18.20240130

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mothertongues 0.18.20240130
File Size Uploaded
mothertongues-0.18.20240130.tar.gz 735.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mothertongues 0.18.20240130
File Interpreter ABI Platform
mothertongues-0.18.20240130-py3-none-any.whl Python 3 none any Details

Total release size: 1.5 MB

Release files / mothertongues-0.18.20240130.tar.gz

Download URL mothertongues-0.18.20240130.tar.gz
Size 735.5 kB
Tags Source
SHA-256 checksum
How to use checksums
4302a380cbb05f6708413c7e566b91fcef8ccfbe1a98d1f76c1242df8f445d8b
BLAKE2b-256 checksum
How to use checksums
12d25fbaa2ea96da81f4c0bac34dd390f1fc331b997fa992beeca39d725dd775
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release files / mothertongues-0.18.20240130-py3-none-any.whl

Download URL mothertongues-0.18.20240130-py3-none-any.whl
Size 777.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f5ca7d1e72566556aed4c8726402f5f480ea227855394c2ec84704fb54742a71
BLAKE2b-256 checksum
How to use checksums
b4f31872066d78fe96010f3fb6b69e06b63d457304044687a31e24eb92e42eec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page