| Name | paralex JSON |
| Version |
2.2.3
JSON |
| download |
| home_page | None |
| Summary | Standard for lexicons of inflected paradigms |
| upload_time | 2024-12-19 14:22:01 |
| maintainer | None |
| docs_url | None |
| author | Sacha Beniamine |
| requires_python | >=3.9 |
| license | None |
| 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/ab/36/3a41d52a532ff86b272cabc426b59ac51bd093da18015a3af3e7742fca44/paralex-2.2.3.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.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06408b3d69299ebed45866f32e38bf7c13f4f9ccdaae84e7373ea485bf1ab57e",
"md5": "7556a408e92816308ee96629af8b5ae6",
"sha256": "66cae162621dee3e885af842f36c90dae4349c6c76c9d885862fc7e616dd76e7"
},
"downloads": -1,
"filename": "paralex-2.2.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7556a408e92816308ee96629af8b5ae6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 371412,
"upload_time": "2024-12-19T14:21:58",
"upload_time_iso_8601": "2024-12-19T14:21:58.005723Z",
"url": "https://files.pythonhosted.org/packages/06/40/8b3d69299ebed45866f32e38bf7c13f4f9ccdaae84e7373ea485bf1ab57e/paralex-2.2.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ab363a41d52a532ff86b272cabc426b59ac51bd093da18015a3af3e7742fca44",
"md5": "eaf4dcb8bd2e9c0de88aa7a506fba379",
"sha256": "3d5d2062c9e2ddd8db6c654bfc36cc17ba79398adcf57007f458939a8b79fb0d"
},
"downloads": -1,
"filename": "paralex-2.2.3.tar.gz",
"has_sig": false,
"md5_digest": "eaf4dcb8bd2e9c0de88aa7a506fba379",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 351385,
"upload_time": "2024-12-19T14:22:01",
"upload_time_iso_8601": "2024-12-19T14:22:01.707264Z",
"url": "https://files.pythonhosted.org/packages/ab/36/3a41d52a532ff86b272cabc426b59ac51bd093da18015a3af3e7742fca44/paralex-2.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 14:22:01",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "paralex"
}
