clld


Nameclld JSON
Version 11.3.1 PyPI version JSON
download
home_pagehttps://clld.org
SummaryPython library supporting the development of cross-linguistic databases
upload_time2024-10-24 05:48:59
maintainerNone
docs_urlNone
authorRobert Forkel
requires_python>=3.8
licenseApache 2.0
keywords web pyramid lrl linguistics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # clld

The `clld` toolkit - a web framework for the publication of
[Cross-Linguistic Linked Data](https://clld.org).

Documentation for the code base and its use is available at https://clld.readthedocs.io/en/latest/.
The source for this documentation is in the `docs` directory.

[![Build Status](https://github.com/clld/clld/workflows/tests/badge.svg)](https://github.com/clld/clld/actions?query=workflow%3Atests)
[![PyPI](https://img.shields.io/pypi/v/clld.svg)](https://pypi.python.org/pypi/clld)
[![Documentation Status](http://readthedocs.org/projects/clld/badge/?version=latest)](http://clld.readthedocs.io/en/latest/?badge=latest)

## How to cite

To cite the `clld` software, please cite the presentation introducing it

> Forkel, R., & Bank, S. (2014, October 7). The clld toolkit. Language Comparison with Linguistic Databases: RefLex and Typological Databases, Nijmegen. Zenodo. https://doi.org/10.5281/zenodo.10846846


## Usage

Once the initial steps (installation, bootstrapping a new project)
have been done helped by [the online documentation](https://clld.readthedocs.io/en/latest/),
the biggest resource to guide further development of a `clld` app
is the [wealth of existing apps](https://github.com/clld/clld/network/dependents).
(Note: GitHub's "Used by" links - created from the dependency graph data - are really
helpful here!)
The following pointers are meant as a
starting point to solve specific problems by perusing the code of other
apps.

- **Integrating language metadata from Glottolog**: There's 
  [a plugin](https://github.com/clld/clld-glottologfamily-plugin) for that
  and here's the list of apps on GitHub using it: https://github.com/clld/clld-glottologfamily-plugin/network/dependents
- **Displaying (data on) phylogenetic laguage trees**: There's
  [a plugin](https://github.com/clld/clld-phylogeny-plugin) for that
  and here's the list of apps on GitHub using it: https://github.com/clld/clld-phylogeny-plugin/network/dependents
- **Displaying cognacy relations between words**: There's
  [a plugin](https://github.com/clld/clld-cognacy-plugin) for that
  and here's the list of apps on GitHub using it: https://github.com/clld/clld-cognacy-plugin/network/dependents
- **Displaying phoneme inventories as IPA charts**: There's
  [a plugin](https://github.com/clld/clld-ipachart-plugin) for that
  and here's the list of apps on GitHub using it: https://github.com/clld/clld-ipachart-plugin/network/dependents
- **Integrating audio recordings of lexical data**: There's
  [a plugin](https://github.com/clld/clld-audio-plugin) for that
  and here's the list of apps on GitHub using it: https://github.com/clld/clld-audio-plugin/network/dependents
- **Rendering CLDF Markdown in the context of the app**: There's
  [a plugin](https://github.com/clld/clld-markdown-plugin) for that.
- **Aggregating data from multiple CLDF datasets**: The app serving the
  [Intercontinental Dictionary Series](https://ids.clld.org) does this.
  Very simple per-dataset metadata of the form
  ```json
  {
    "id": "ids-cosgrovevoro",
    "repo": "https://github.com/intercontinental-dictionary-series/cosgrovevoro",
    "doi": "10.5281/zenodo.4280576",
    "order": 2
  }
  ```
  is read and used to populate the database, see
  https://github.com/clld/ids/blob/master/ids/scripts/initializedb.py#L38-L67
- **Aggregating data from different CLDF modules**: While most `clld` apps are
  concerned with just one type of data (e.g. typological questionnaires as in WALS,
  or wordlists as in IDS), some have a different focus (e.g.
  [TuLaR (TupĂ­an Language Resources)](https://tular.clld.org)). The TuLaR
  app aggregates data which is curated in several datasets, bundled under
  a [Zenodo community](https://zenodo.org/communities/tular), see https://github.com/tupian-language-resources/tular/blob/main/tular/scripts/initializedb.py
- **Using Charis SIL fonts**: using [SIL's Charis fonts](https://software.sil.org/charis/) on a `clld` page is simple. Here's an example
  https://ids.clld.org/valuesets/1-100-316
  - Include the relevant style sheet (which will pull in the font resources):
    https://github.com/clld/ids/blob/b2884e06a53a0a3c7a0dc27955c314869d0a31aa/ids/templates/ids.mako#L10-L12
  - Then assign the appropriate css class:
    https://github.com/clld/ids/blob/b2884e06a53a0a3c7a0dc27955c314869d0a31aa/ids/templates/unit/detail_html.mako#L6


## See

- The [CLLD project](https://clld.org)
- [Online documentation](https://clld.readthedocs.io/en/latest/)
- [Presentation on clld from 2014](https://clld.org/docs/reflex/clld.pdf)

            

Raw data

            {
    "_id": null,
    "home_page": "https://clld.org",
    "name": "clld",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "web pyramid LRL Linguistics",
    "author": "Robert Forkel",
    "author_email": "robert_forkel@eva.mpg.de",
    "download_url": "https://files.pythonhosted.org/packages/06/8d/d63d956cb8d6293a6a3e224ca4207100821d47328116dfcb72802451d2a0/clld-11.3.1.tar.gz",
    "platform": null,
    "description": "# clld\n\nThe `clld` toolkit - a web framework for the publication of\n[Cross-Linguistic Linked Data](https://clld.org).\n\nDocumentation for the code base and its use is available at https://clld.readthedocs.io/en/latest/.\nThe source for this documentation is in the `docs` directory.\n\n[![Build Status](https://github.com/clld/clld/workflows/tests/badge.svg)](https://github.com/clld/clld/actions?query=workflow%3Atests)\n[![PyPI](https://img.shields.io/pypi/v/clld.svg)](https://pypi.python.org/pypi/clld)\n[![Documentation Status](http://readthedocs.org/projects/clld/badge/?version=latest)](http://clld.readthedocs.io/en/latest/?badge=latest)\n\n## How to cite\n\nTo cite the `clld` software, please cite the presentation introducing it\n\n> Forkel, R., & Bank, S. (2014, October 7). The clld toolkit. Language Comparison with Linguistic Databases: RefLex and Typological Databases, Nijmegen. Zenodo. https://doi.org/10.5281/zenodo.10846846\n\n\n## Usage\n\nOnce the initial steps (installation, bootstrapping a new project)\nhave been done helped by [the online documentation](https://clld.readthedocs.io/en/latest/),\nthe biggest resource to guide further development of a `clld` app\nis the [wealth of existing apps](https://github.com/clld/clld/network/dependents).\n(Note: GitHub's \"Used by\" links - created from the dependency graph data - are really\nhelpful here!)\nThe following pointers are meant as a\nstarting point to solve specific problems by perusing the code of other\napps.\n\n- **Integrating language metadata from Glottolog**: There's \n  [a plugin](https://github.com/clld/clld-glottologfamily-plugin) for that\n  and here's the list of apps on GitHub using it: https://github.com/clld/clld-glottologfamily-plugin/network/dependents\n- **Displaying (data on) phylogenetic laguage trees**: There's\n  [a plugin](https://github.com/clld/clld-phylogeny-plugin) for that\n  and here's the list of apps on GitHub using it: https://github.com/clld/clld-phylogeny-plugin/network/dependents\n- **Displaying cognacy relations between words**: There's\n  [a plugin](https://github.com/clld/clld-cognacy-plugin) for that\n  and here's the list of apps on GitHub using it: https://github.com/clld/clld-cognacy-plugin/network/dependents\n- **Displaying phoneme inventories as IPA charts**: There's\n  [a plugin](https://github.com/clld/clld-ipachart-plugin) for that\n  and here's the list of apps on GitHub using it: https://github.com/clld/clld-ipachart-plugin/network/dependents\n- **Integrating audio recordings of lexical data**: There's\n  [a plugin](https://github.com/clld/clld-audio-plugin) for that\n  and here's the list of apps on GitHub using it: https://github.com/clld/clld-audio-plugin/network/dependents\n- **Rendering CLDF Markdown in the context of the app**: There's\n  [a plugin](https://github.com/clld/clld-markdown-plugin) for that.\n- **Aggregating data from multiple CLDF datasets**: The app serving the\n  [Intercontinental Dictionary Series](https://ids.clld.org) does this.\n  Very simple per-dataset metadata of the form\n  ```json\n  {\n    \"id\": \"ids-cosgrovevoro\",\n    \"repo\": \"https://github.com/intercontinental-dictionary-series/cosgrovevoro\",\n    \"doi\": \"10.5281/zenodo.4280576\",\n    \"order\": 2\n  }\n  ```\n  is read and used to populate the database, see\n  https://github.com/clld/ids/blob/master/ids/scripts/initializedb.py#L38-L67\n- **Aggregating data from different CLDF modules**: While most `clld` apps are\n  concerned with just one type of data (e.g. typological questionnaires as in WALS,\n  or wordlists as in IDS), some have a different focus (e.g.\n  [TuLaR (Tup\u00edan Language Resources)](https://tular.clld.org)). The TuLaR\n  app aggregates data which is curated in several datasets, bundled under\n  a [Zenodo community](https://zenodo.org/communities/tular), see https://github.com/tupian-language-resources/tular/blob/main/tular/scripts/initializedb.py\n- **Using Charis SIL fonts**: using [SIL's Charis fonts](https://software.sil.org/charis/) on a `clld` page is simple. Here's an example\n  https://ids.clld.org/valuesets/1-100-316\n  - Include the relevant style sheet (which will pull in the font resources):\n    https://github.com/clld/ids/blob/b2884e06a53a0a3c7a0dc27955c314869d0a31aa/ids/templates/ids.mako#L10-L12\n  - Then assign the appropriate css class:\n    https://github.com/clld/ids/blob/b2884e06a53a0a3c7a0dc27955c314869d0a31aa/ids/templates/unit/detail_html.mako#L6\n\n\n## See\n\n- The [CLLD project](https://clld.org)\n- [Online documentation](https://clld.readthedocs.io/en/latest/)\n- [Presentation on clld from 2014](https://clld.org/docs/reflex/clld.pdf)\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "Python library supporting the development of cross-linguistic databases",
    "version": "11.3.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/clld/clld/issues",
        "Homepage": "https://clld.org",
        "Source": "https://github.com/clld/clld"
    },
    "split_keywords": [
        "web",
        "pyramid",
        "lrl",
        "linguistics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7c7222b177ad97339d6d6dc308f0ae40df47908d2cfe0d12b9f9ab80d40009ab",
                "md5": "2f3389b3a74b75a71faecb9e21833535",
                "sha256": "b95d1c89a36895aba34e7a754a223d6bfc5ac51c7ada7fb44ab99a72310e099a"
            },
            "downloads": -1,
            "filename": "clld-11.3.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2f3389b3a74b75a71faecb9e21833535",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.8",
            "size": 8396147,
            "upload_time": "2024-10-24T05:48:13",
            "upload_time_iso_8601": "2024-10-24T05:48:13.982792Z",
            "url": "https://files.pythonhosted.org/packages/7c/72/22b177ad97339d6d6dc308f0ae40df47908d2cfe0d12b9f9ab80d40009ab/clld-11.3.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "068dd63d956cb8d6293a6a3e224ca4207100821d47328116dfcb72802451d2a0",
                "md5": "7d0a5b38ee8c29dfef1a9a3ebddaa3b9",
                "sha256": "59471ddfbcbc6db48ea1fecf9fe3358cbb5f7fa4e10bca459ac59b13483470ec"
            },
            "downloads": -1,
            "filename": "clld-11.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "7d0a5b38ee8c29dfef1a9a3ebddaa3b9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 8324697,
            "upload_time": "2024-10-24T05:48:59",
            "upload_time_iso_8601": "2024-10-24T05:48:59.655223Z",
            "url": "https://files.pythonhosted.org/packages/06/8d/d63d956cb8d6293a6a3e224ca4207100821d47328116dfcb72802451d2a0/clld-11.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-24 05:48:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "clld",
    "github_project": "clld",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "clld"
}
        
Elapsed time: 0.44618s