toRST

Name	toRST JSON
Version	0.1.51 JSON
	download
home_page	https://github.com/jrey999/toRST
Summary	Command line tool for converting CSV and JSON files into reStructuredText Tables.
upload_time	2024-03-28 14:29:42
maintainer	None
docs_url	None
author	John Reynolds
requires_python	None
license	The MIT License (MIT) Copyright © 2024 John Reynolds Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            ==========================================================
<br>toRST
=====

Convert various data formats to reStructuredText tables.

**Currently supports**:
----------------------

- CSV
- JSON

**Planned formats**:


- Excel<br><br>

**installation**
```bash
pip install toRST
```
<br>

**CLI Usage**
-------------
example<br>
  Convert file1.csv and file2.json into RST
```bash
torst file1.csv file2.json -o /outputfolder
```

**Positional Arguments**:
------------------------

inputs
  One or more input files to convert to RST. Currently only CSV and JSON files are 
  supported, but additional formats will be added.

**Optional Arguments**:
---------------------- 

-o, --output_dir
  Output directory for generated RST files. Defaults to the current 
  working directory if not provided.

**Python Usage**
-------------
example<br>
  
Import Table class
```python
from toRST.toRST import Table
```
Convert file1.csv into RST string
```python
rst_table = Table('file1.csv').build_table()
```
Can also convert ```list[list or tuple or dict] and dict[str, list]``` into RST by passing the object into the ```Table``` class<br>

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jrey999/toRST",
    "name": "toRST",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "John Reynolds",
    "author_email": "reynoldsjohngreg@gmail.com",
    "download_url": null,
    "platform": null,
    "description": "==========================================================\n<br>toRST\n=====\n\nConvert various data formats to reStructuredText tables.\n\n**Currently supports**:\n----------------------\n\n- CSV\n- JSON\n\n**Planned formats**:\n\n\n- Excel<br><br>\n\n**installation**\n```bash\npip install toRST\n```\n<br>\n\n**CLI Usage**\n-------------\nexample<br>\n  Convert file1.csv and file2.json into RST\n```bash\ntorst file1.csv file2.json -o /outputfolder\n```\n\n**Positional Arguments**:\n------------------------\n\ninputs\n  One or more input files to convert to RST. Currently only CSV and JSON files are \n  supported, but additional formats will be added.\n\n**Optional Arguments**:\n---------------------- \n\n-o, --output_dir\n  Output directory for generated RST files. Defaults to the current \n  working directory if not provided.\n\n**Python Usage**\n-------------\nexample<br>\n  \nImport Table class\n```python\nfrom toRST.toRST import Table\n```\nConvert file1.csv into RST string\n```python\nrst_table = Table('file1.csv').build_table()\n```\nCan also convert ```list[list or tuple or dict] and dict[str, list]``` into RST by passing the object into the ```Table``` class<br>\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT) Copyright \u00a9 2024 John Reynolds  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Command line tool for converting CSV and JSON files into reStructuredText Tables.",
    "version": "0.1.51",
    "project_urls": {
        "Bug Tracker": "https://github.com/jrey999/toRST/issues",
        "Homepage": "https://github.com/jrey999/toRST"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "920fab3287bf6ba34cbf985549106578bde15009e497ad484d3f45141849b19a",
                "md5": "72f940468b310b5b8a6f0197eb6df24f",
                "sha256": "a72b748e8524d5f053fdc7c540c26bc649d2e878bd665c931963368fbcae5670"
            },
            "downloads": -1,
            "filename": "toRST-0.1.51-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "72f940468b310b5b8a6f0197eb6df24f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 9057,
            "upload_time": "2024-03-28T14:29:42",
            "upload_time_iso_8601": "2024-03-28T14:29:42.304491Z",
            "url": "https://files.pythonhosted.org/packages/92/0f/ab3287bf6ba34cbf985549106578bde15009e497ad484d3f45141849b19a/toRST-0.1.51-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-28 14:29:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jrey999",
    "github_project": "toRST",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "torst"
}