paralex


Nameparalex JSON
Version 2.2.4 PyPI version JSON
download
home_pageNone
SummaryStandard for lexicons of inflected paradigms
upload_time2025-02-05 14:29:28
maintainerNone
docs_urlNone
authorSacha Beniamine
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Paralex: lexicons of morphological paradigms

[Paralex](https://www.paralex-standard.org) is a standard for morphological lexicons which document inflectional paradigms.

This package contains:
- The paralex specification
- The full documentation
- Utilities to generate metadata and to validate paralex lexicons

# Generating metadata

To generate paralex metadata (more in the docs):


```python title="gen-metadata.py"
from paralex import paralex_factory

package = paralex_factory("Vulcan Verbal Paradigms",
                          {
                              "forms": {"path": "vulcan_v_forms.csv"},
                          }
                          )
package.to_json("vulcan.package.json")
```

The package returned is a [frictionless Package object](https://framework.frictionlessdata.io/docs/framework/package.html) and can be manipulated as such as needed.


# Validation of paralex datasets

To validate a paralex lexicon:

~~~
    paralex validate <mypackagename>.package.json
~~~

This checks that the data is valid using frictionless, as well as a number of statements to match the paralex standard.
For a detailed report on frictionless metadata, do:


~~~
    frictionless validate <mypackagename>.package.json
~~~

# Accessing datasets

Available datasets in the Zenodo community:

~~~
    paralex list
~~~

Download a dataset and extract the .zip archive:

~~~
    paralex get <ZENODO_ID>
~~~

The Zenodo ID can be found with the `paralex list` command.

# Serving the paralex site

First, build the standard package from files:

~~~
	paralex make_standard
~~~

Second, build the specs files from the standard package:

~~~
	paralex make_doc
~~~

Third, use mkdocs (which needs to be installed) to build this site:

~~~
	mkdocs serve
~~~

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "paralex",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Sacha Beniamine",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/a4/c7/608f3d5a38603afb2699c08f69e21e40ef22c09d9ab169bac5d2bfe51949/paralex-2.2.4.tar.gz",
    "platform": null,
    "description": "# Paralex: lexicons of morphological paradigms\n\n[Paralex](https://www.paralex-standard.org) is a standard for morphological lexicons which document inflectional paradigms.\n\nThis package contains:\n- The paralex specification\n- The full documentation\n- Utilities to generate metadata and to validate paralex lexicons\n\n# Generating metadata\n\nTo generate paralex metadata (more in the docs):\n\n\n```python title=\"gen-metadata.py\"\nfrom paralex import paralex_factory\n\npackage = paralex_factory(\"Vulcan Verbal Paradigms\",\n                          {\n                              \"forms\": {\"path\": \"vulcan_v_forms.csv\"},\n                          }\n                          )\npackage.to_json(\"vulcan.package.json\")\n```\n\nThe package returned is a [frictionless Package object](https://framework.frictionlessdata.io/docs/framework/package.html) and can be manipulated as such as needed.\n\n\n# Validation of paralex datasets\n\nTo validate a paralex lexicon:\n\n~~~\n    paralex validate <mypackagename>.package.json\n~~~\n\nThis checks that the data is valid using frictionless, as well as a number of statements to match the paralex standard.\nFor a detailed report on frictionless metadata, do:\n\n\n~~~\n    frictionless validate <mypackagename>.package.json\n~~~\n\n# Accessing datasets\n\nAvailable datasets in the Zenodo community:\n\n~~~\n    paralex list\n~~~\n\nDownload a dataset and extract the .zip archive:\n\n~~~\n    paralex get <ZENODO_ID>\n~~~\n\nThe Zenodo ID can be found with the `paralex list` command.\n\n# Serving the paralex site\n\nFirst, build the standard package from files:\n\n~~~\n\tparalex make_standard\n~~~\n\nSecond, build the specs files from the standard package:\n\n~~~\n\tparalex make_doc\n~~~\n\nThird, use mkdocs (which needs to be installed) to build this site:\n\n~~~\n\tmkdocs serve\n~~~\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Standard for lexicons of inflected paradigms",
    "version": "2.2.4",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "daf746580e6fd5a21b027fb73d5646dfcfd265c447b7bca1ec710d0629cb4b57",
                "md5": "3349798297b071e96414efc18eb9d53e",
                "sha256": "aa1a804b400e0ffc99230e2973930346d2b3d99981153532e9367125be8c83e9"
            },
            "downloads": -1,
            "filename": "paralex-2.2.4-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3349798297b071e96414efc18eb9d53e",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.9",
            "size": 371589,
            "upload_time": "2025-02-05T14:29:26",
            "upload_time_iso_8601": "2025-02-05T14:29:26.619501Z",
            "url": "https://files.pythonhosted.org/packages/da/f7/46580e6fd5a21b027fb73d5646dfcfd265c447b7bca1ec710d0629cb4b57/paralex-2.2.4-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a4c7608f3d5a38603afb2699c08f69e21e40ef22c09d9ab169bac5d2bfe51949",
                "md5": "95358c1f15fdc26f412d65fd2dc74324",
                "sha256": "866d222d1deeb6d20da576612a67c6edd810a34bda26c4d07d22368692740cd2"
            },
            "downloads": -1,
            "filename": "paralex-2.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "95358c1f15fdc26f412d65fd2dc74324",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 351575,
            "upload_time": "2025-02-05T14:29:28",
            "upload_time_iso_8601": "2025-02-05T14:29:28.123501Z",
            "url": "https://files.pythonhosted.org/packages/a4/c7/608f3d5a38603afb2699c08f69e21e40ef22c09d9ab169bac5d2bfe51949/paralex-2.2.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-05 14:29:28",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "paralex"
}
        
Elapsed time: 1.62074s