camel2karam


Namecamel2karam JSON
Version 0.0.3 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2024-11-12 15:11:31
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords convert
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Camel 2 KARAM
[![PyPI - Version](https://img.shields.io/pypi/v/camel2karam.svg)](https://pypi.org/project/camel2karam)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/camel2karam.svg)](https://pypi.org/project/camel2karam)

Camel 2 KARAM

---

**Table des matières**

- [Installation](#installation)
- [Usage](#usage)
- [License](#license)

## Installation
### PyPi
Camel 2 KARAM est disponible sur PyPi, vous pouvez l'installer avec pip à l'aide de la commande suivante:
```bash
pip install camel2karam
```
Vous pouvez ensuite vérifier que l'installation s'est bien passée en lançant la commande `camel2karam --version`

### Développement
Pour installer Europarser en mode développement, vous pouvez cloner le dépôt git et installer les dépendances avec pip:
```bash
git clone https://github.com/CERES-Sorbonne/C2K.git
cd C2K
pip install -e .
```

## Usages
#### Usage basique
```python
from pathlib import Path

from camel2karam.converters import PartsMapping, Csv2Connlu, CsvSent2CsvTok, CsvSent2OneLetterTag, CsvTok2CsvSent, Jsonl2Connlu, Jsonl2Csv, Jsonl2Xml, TagsetConvert # Liste de tous les convertisseurs disponibles (et PartsMapping)

input_folder = Path('/path/to/your/input')
output_folder = Path('/path/to/your/output')

converter = Jsonl2Connlu() # Changer le convertisseur ici
converter.folder_converter(input_folder, output_folder)
```

Certains convertisseurs nécessitent des paramètres supplémentaires, vous pouvez les passer en argument du constructeur du convertisseur.
Par exemple, les convertisseurs prenant des fichiers CSVs en entrée vous demanderont le mapping des colonnes : 
```python
from camel2karam.converters import Csv2Connlu
c2c = Csv2Connlu()

c2c.folder_converter(
    "path/to/your/input",
    "path/to/your/output",
    word_col="word",
    pos_col="pos",
    pos2_col=None
)
```

### Caveats
The `Jsonl2WebAnno` converter (in the `converters.jsonl2webanno` file) needs an extra dependency to work properly. You can install it with the following command:
```bash
pip install git+https://github.com/neuged/webanno_tsv.git
```

## License

`camel2karam` est distribué sous les termes de la licence [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "camel2karam",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "convert",
    "author": null,
    "author_email": "Marceau-h <pypi@marceau-h.fr>",
    "download_url": "https://files.pythonhosted.org/packages/98/af/c6b1bbce296f104c853c1989139fb674e198486e8ae41d76b27f9bd58af9/camel2karam-0.0.3.tar.gz",
    "platform": null,
    "description": "# Camel 2 KARAM\n[![PyPI - Version](https://img.shields.io/pypi/v/camel2karam.svg)](https://pypi.org/project/camel2karam)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/camel2karam.svg)](https://pypi.org/project/camel2karam)\n\nCamel 2 KARAM\n\n---\n\n**Table des mati\u00e8res**\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [License](#license)\n\n## Installation\n### PyPi\nCamel 2 KARAM est disponible sur PyPi, vous pouvez l'installer avec pip \u00e0 l'aide de la commande suivante:\n```bash\npip install camel2karam\n```\nVous pouvez ensuite v\u00e9rifier que l'installation s'est bien pass\u00e9e en lan\u00e7ant la commande `camel2karam --version`\n\n### D\u00e9veloppement\nPour installer Europarser en mode d\u00e9veloppement, vous pouvez cloner le d\u00e9p\u00f4t git et installer les d\u00e9pendances avec pip:\n```bash\ngit clone https://github.com/CERES-Sorbonne/C2K.git\ncd C2K\npip install -e .\n```\n\n## Usages\n#### Usage basique\n```python\nfrom pathlib import Path\n\nfrom camel2karam.converters import PartsMapping, Csv2Connlu, CsvSent2CsvTok, CsvSent2OneLetterTag, CsvTok2CsvSent, Jsonl2Connlu, Jsonl2Csv, Jsonl2Xml, TagsetConvert # Liste de tous les convertisseurs disponibles (et PartsMapping)\n\ninput_folder = Path('/path/to/your/input')\noutput_folder = Path('/path/to/your/output')\n\nconverter = Jsonl2Connlu() # Changer le convertisseur ici\nconverter.folder_converter(input_folder, output_folder)\n```\n\nCertains convertisseurs n\u00e9cessitent des param\u00e8tres suppl\u00e9mentaires, vous pouvez les passer en argument du constructeur du convertisseur.\nPar exemple, les convertisseurs prenant des fichiers CSVs en entr\u00e9e vous demanderont le mapping des colonnes : \n```python\nfrom camel2karam.converters import Csv2Connlu\nc2c = Csv2Connlu()\n\nc2c.folder_converter(\n    \"path/to/your/input\",\n    \"path/to/your/output\",\n    word_col=\"word\",\n    pos_col=\"pos\",\n    pos2_col=None\n)\n```\n\n### Caveats\nThe `Jsonl2WebAnno` converter (in the `converters.jsonl2webanno` file) needs an extra dependency to work properly. You can install it with the following command:\n```bash\npip install git+https://github.com/neuged/webanno_tsv.git\n```\n\n## License\n\n`camel2karam` est distribu\u00e9 sous les termes de la licence [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "0.0.3",
    "project_urls": {
        "Documentation": "https://github.com/CERES-Sorbonne/C2K#readme",
        "Homepage": "https://github.com/CERES-Sorbonne/C2K",
        "Issues": "https://github.com/CERES-Sorbonne/C2K/issues",
        "Source": "https://github.com/CERES-Sorbonne/C2K"
    },
    "split_keywords": [
        "convert"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9021487b2a5e8e56752ca7cc9326639c2b71c6851e9cc493ee7940b4c3c25c29",
                "md5": "6930f39fd6e73a8d98b1aa9a779ea9d8",
                "sha256": "8f82f85a8bcd812e7a4f92be110a1fc1b7935d43569f49856ae74d778ff38d61"
            },
            "downloads": -1,
            "filename": "camel2karam-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6930f39fd6e73a8d98b1aa9a779ea9d8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 40790,
            "upload_time": "2024-11-12T15:11:33",
            "upload_time_iso_8601": "2024-11-12T15:11:33.001312Z",
            "url": "https://files.pythonhosted.org/packages/90/21/487b2a5e8e56752ca7cc9326639c2b71c6851e9cc493ee7940b4c3c25c29/camel2karam-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "98afc6b1bbce296f104c853c1989139fb674e198486e8ae41d76b27f9bd58af9",
                "md5": "1d643e83d65e0af6f3a61ddc3afef8c0",
                "sha256": "b58e14163a8259164e912b48c2c3ffe70ddb9bd24dc56b7ed7baf64439a36b45"
            },
            "downloads": -1,
            "filename": "camel2karam-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "1d643e83d65e0af6f3a61ddc3afef8c0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 33683,
            "upload_time": "2024-11-12T15:11:31",
            "upload_time_iso_8601": "2024-11-12T15:11:31.874832Z",
            "url": "https://files.pythonhosted.org/packages/98/af/c6b1bbce296f104c853c1989139fb674e198486e8ae41d76b27f9bd58af9/camel2karam-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-12 15:11:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CERES-Sorbonne",
    "github_project": "C2K#readme",
    "github_not_found": true,
    "lcname": "camel2karam"
}
        
Elapsed time: 0.37582s