{"id":14065625,"url":"https://github.com/pyexcel/pyexcel-cli","last_synced_at":"2025-05-01T03:31:37.763Z","repository":{"id":80824409,"uuid":"61566457","full_name":"pyexcel/pyexcel-cli","owner":"pyexcel","description":"A command utility to read and write data into csv, tsv, xls, xlsx and ods format.","archived":false,"fork":false,"pushed_at":"2025-04-18T07:51:51.000Z","size":422,"stargazers_count":31,"open_issues_count":1,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-30T12:23:34.557Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://cli.pyexcel.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pyexcel.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"github":"chfw","patreon":"chfw"}},"created_at":"2016-06-20T17:20:34.000Z","updated_at":"2025-04-18T07:51:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"5e4bbc66-e8da-41f8-a0e2-1fd090aec0be","html_url":"https://github.com/pyexcel/pyexcel-cli","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel%2Fpyexcel-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel%2Fpyexcel-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel%2Fpyexcel-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyexcel%2Fpyexcel-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyexcel","download_url":"https://codeload.github.com/pyexcel/pyexcel-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251818233,"owners_count":21648859,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-13T07:04:35.993Z","updated_at":"2025-05-01T03:31:37.756Z","avatar_url":"https://github.com/pyexcel.png","language":"Python","readme":"================================================================================\npyexcel-cli - Let you focus on data at command line, instead of file formats\n================================================================================\n\n.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png\n   :target: https://www.patreon.com/chfw\n\n.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel-mobans/master/images/awesome-badge.svg\n   :target: https://awesome-python.com/#specific-formats-processing\n\n.. image:: https://codecov.io/gh/pyexcel/pyexcel-cli/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/pyexcel/pyexcel-cli\n\n.. image:: https://badge.fury.io/py/pyexcel-cli.svg\n   :target: https://pypi.org/project/pyexcel-cli\n\n\n\n.. image:: https://pepy.tech/badge/pyexcel-cli/month\n   :target: https://pepy.tech/project/pyexcel-cli\n\n\n.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg\n   :target: https://gitter.im/pyexcel/Lobby\n\n.. image:: https://img.shields.io/static/v1?label=continuous%20templating\u0026message=%E6%A8%A1%E7%89%88%E6%9B%B4%E6%96%B0\u0026color=blue\u0026style=flat-square\n    :target: https://moban.readthedocs.io/en/latest/#at-scale-continous-templating-for-open-source-projects\n\n.. image:: https://img.shields.io/static/v1?label=coding%20style\u0026message=black\u0026color=black\u0026style=flat-square\n    :target: https://github.com/psf/black\n.. image:: https://readthedocs.org/projects/pyexcel-cli/badge/?version=latest\n   :target: http://pyexcel-cli.readthedocs.org/en/latest/\n\nSupport the project\n================================================================================\n\nIf your company uses pyexcel and its components in a revenue-generating product,\nplease consider supporting the project on GitHub or\n`Patreon \u003chttps://www.patreon.com/bePatron?u=5537627\u003e`_. Your financial\nsupport will enable me to dedicate more time to coding, improving documentation,\nand creating engaging content.\n\n\nKnown constraints\n==================\n\nFonts, colors and charts are not supported.\n\nNor to read password protected xls, xlsx and ods files.\n\nIntroduction\n================================================================================\n\n**pyexcel-cli** brings `pyexcel \u003chttps://github.com/pyexcel/pyexcel\u003e`_ to make it easy\nto consume/produce information stored in excel files on command line interface.\nThis library can turn the excel data into a list of lists, a list of records(dictionaries),\ndictionaries of lists. And vice versa. Hence it lets you focus on data in shell\nprogramming, instead of file formats.\n\nHightlighted features:\n\n#. View data in the excel files without Microsoft Office or Open Office\n#. Transcode data among supported excel file formats\n#. Merge files in various excel file formats into one\n#. Split a multi-sheet excel file into single sheet files\n#. Find difference in data between two excel files\n\nUsage\n================================================================================\n\n.. code-block:: bash\n\n   $ cd demo\n   $ pyexcel view --in-browser --output-file-type sortable.html --sheet-index 0 https://github.com/pyexcel/excel2table/raw/master/sample/goog.ods\n\nHere's what you will get:\n\n.. image:: https://github.com/pyexcel/pyexcel-cli/raw/master/pyexcel-cli-sortable.gif\n\n.. note::\n\n   You will need to install pyexcel-sortable, which renders it.\n\nHere is another cli example usage:\n\n.. code-block:: bash\n\n    $ pyexcel view https://github.com/pyexcel/pyexcel-cli/blob/master/tests/fixtures/multiple-sheets.xls\n    Sheet 1:\n    +---+---+---+\n    | 1 | 2 | 3 |\n    +---+---+---+\n    | 4 | 5 | 6 |\n    +---+---+---+\n    | 7 | 8 | 9 |\n    +---+---+---+\n    Sheet 2:\n    +---+---+---+\n    | X | Y | Z |\n    +---+---+---+\n    | 1 | 2 | 3 |\n    +---+---+---+\n    | 4 | 5 | 6 |\n    +---+---+---+\n    Sheet 3:\n    +---+---+---+\n    | O | P | Q |\n    +---+---+---+\n    | 3 | 2 | 1 |\n    +---+---+---+\n    | 4 | 3 | 2 |\n    +---+---+---+\n\nBecause pyexcel family is loosely coupled, especially for file format supports, you\ninstall the libraries that you need to. If you need to support xls format, you will\nneed to install pyexcel-xls. For more information, please see the plugin section.\n\n\n.. _file-format-list:\n.. _a-map-of-plugins-and-file-formats:\n\n.. table:: A list of file formats supported by external plugins\n\n   ======================== ======================= =================\n   Package name              Supported file formats  Dependencies\n   ======================== ======================= =================\n   `pyexcel-io`_            csv, csvz [#f1]_, tsv,  csvz,tsvz readers depends on `chardet`\n                            tsvz [#f2]_\n   `pyexcel-xls`_           xls, xlsx(read only),   `xlrd`_,\n                            xlsm(read only)         `xlwt`_\n   `pyexcel-xlsx`_          xlsx                    `openpyxl`_\n   `pyexcel-ods3`_          ods                     `pyexcel-ezodf`_,\n                                                    lxml\n   `pyexcel-ods`_           ods                     `odfpy`_\n   ======================== ======================= =================\n\n.. table:: Dedicated file reader and writers\n\n   ======================== ======================= =================\n   Package name              Supported file formats  Dependencies\n   ======================== ======================= =================\n   `pyexcel-xlsxw`_         xlsx(write only)        `XlsxWriter`_\n   `pyexcel-libxlsxw`_      xlsx(write only)        `libxlsxwriter`_\n   `pyexcel-xlsxr`_         xlsx(read only)         lxml\n   `pyexcel-xlsbr`_         xlsb(read only)         pyxlsb\n   `pyexcel-odsr`_          read only for ods, fods lxml\n   `pyexcel-odsw`_          write only for ods      loxun\n   `pyexcel-htmlr`_         html(read only)         lxml,html5lib\n   `pyexcel-pdfr`_          pdf(read only)          camelot\n   ======================== ======================= =================\n\n\nPlugin shopping guide\n------------------------\n\nSince 2020, all pyexcel-io plugins have dropped the support for python versions\nwhich are lower than 3.6. If you want to use any of those Python versions, please use pyexcel-io\nand its plugins versions that are lower than 0.6.0.\n\n\nExcept csv files, xls, xlsx and ods files are a zip of a folder containing a lot of\nxml files\n\nThe dedicated readers for excel files can stream read\n\n\nIn order to manage the list of plugins installed, you need to use pip to add or remove\na plugin. When you use virtualenv, you can have different plugins per virtual\nenvironment. In the situation where you have multiple plugins that does the same thing\nin your environment, you need to tell pyexcel which plugin to use per function call.\nFor example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr.\nYou need to append get_array(..., library='pyexcel-odsr').\n\n\n\n.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io\n.. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls\n.. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx\n.. _pyexcel-ods: https://github.com/pyexcel/pyexcel-ods\n.. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3\n.. _pyexcel-odsr: https://github.com/pyexcel/pyexcel-odsr\n.. _pyexcel-odsw: https://github.com/pyexcel/pyexcel-odsw\n.. _pyexcel-pdfr: https://github.com/pyexcel/pyexcel-pdfr\n\n.. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw\n.. _pyexcel-libxlsxw: https://github.com/pyexcel/pyexcel-libxlsxw\n.. _pyexcel-xlsxr: https://github.com/pyexcel/pyexcel-xlsxr\n.. _pyexcel-xlsbr: https://github.com/pyexcel/pyexcel-xlsbr\n.. _pyexcel-htmlr: https://github.com/pyexcel/pyexcel-htmlr\n\n.. _xlrd: https://github.com/python-excel/xlrd\n.. _xlwt: https://github.com/python-excel/xlwt\n.. _openpyxl: https://bitbucket.org/openpyxl/openpyxl\n.. _XlsxWriter: https://github.com/jmcnamara/XlsxWriter\n.. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf\n.. _odfpy: https://github.com/eea/odfpy\n.. _libxlsxwriter: http://libxlsxwriter.github.io/getting_started.html\n\n.. table:: Other data renderers\n\n   ======================== ======================= ================= ==================\n   Package name              Supported file formats  Dependencies     Python versions\n   ======================== ======================= ================= ==================\n   `pyexcel-text`_          write only:rst,         `tabulate`_       2.6, 2.7, 3.3, 3.4\n                            mediawiki, html,                          3.5, 3.6, pypy\n                            latex, grid, pipe,\n                            orgtbl, plain simple\n                            read only: ndjson\n                            r/w: json\n   `pyexcel-handsontable`_  handsontable in html    `handsontable`_   same as above\n   `pyexcel-pygal`_         svg chart               `pygal`_          2.7, 3.3, 3.4, 3.5\n                                                                      3.6, pypy\n   `pyexcel-sortable`_      sortable table in html  `csvtotable`_     same as above\n   `pyexcel-gantt`_         gantt chart in html     `frappe-gantt`_   except pypy, same\n                                                                      as above\n   ======================== ======================= ================= ==================\n\n.. _pyexcel-text: https://github.com/pyexcel/pyexcel-text\n.. _tabulate: https://bitbucket.org/astanin/python-tabulate\n.. _pyexcel-handsontable: https://github.com/pyexcel/pyexcel-handsontable\n.. _handsontable: https://cdnjs.com/libraries/handsontable\n.. _pyexcel-pygal: https://github.com/pyexcel/pyexcel-chart\n.. _pygal: https://github.com/Kozea/pygal\n.. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib\n.. _matplotlib: https://matplotlib.org\n.. _pyexcel-sortable: https://github.com/pyexcel/pyexcel-sortable\n.. _csvtotable: https://github.com/vividvilla/csvtotable\n.. _pyexcel-gantt: https://github.com/pyexcel/pyexcel-gantt\n.. _frappe-gantt: https://github.com/frappe/gantt\n\n.. rubric:: Footnotes\n\n.. [#f1] zipped csv file\n.. [#f2] zipped tsv file\n\n\n\n\nInstallation\n================================================================================\n\nYou can install pyexcel-cli via pip:\n\n.. code-block:: bash\n\n    $ pip install pyexcel-cli\n\n\nor clone it and install it:\n\n.. code-block:: bash\n\n    $ git clone https://github.com/pyexcel/pyexcel-cli.git\n    $ cd pyexcel-cli\n    $ python setup.py install\n\n\n\nDevelopment guide\n================================================================================\n\nDevelopment steps for code changes\n\n#. git clone https://github.com/pyexcel/pyexcel-cli.git\n#. cd pyexcel-cli\n\nUpgrade your setup tools and pip. They are needed for development and testing only:\n\n#. pip install --upgrade setuptools pip\n\nThen install relevant development requirements:\n\n#. pip install -r rnd_requirements.txt # if such a file exists\n#. pip install -r requirements.txt\n#. pip install -r tests/requirements.txt\n\nOnce you have finished your changes, please provide test case(s), relevant documentation\nand update changelog.yml\n\n.. note::\n\n    As to rnd_requirements.txt, usually, it is created when a dependent\n    library is not released. Once the dependency is installed\n    (will be released), the future\n    version of the dependency in the requirements.txt will be valid.\n\n\nHow to test your contribution\n--------------------------------------------------------------------------------\n\nAlthough `nose` and `doctest` are both used in code testing, it is advisable\nthat unit tests are put in tests. `doctest` is incorporated only to make sure\nthe code examples in documentation remain valid across different development\nreleases.\n\nOn Linux/Unix systems, please launch your tests like this::\n\n    $ make\n\nOn Windows, please issue this command::\n\n    \u003e test.bat\n\n\nBefore you commit\n------------------------------\n\nPlease run::\n\n    $ make format\n\nso as to beautify your code otherwise your build may fail your unit test.\n\n\n\n\nLicense\n================================================================================\n\nNew BSD License\n","funding_links":["https://github.com/sponsors/chfw","https://patreon.com/chfw","https://www.patreon.com/chfw","https://www.patreon.com/bePatron?u=5537627"],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyexcel%2Fpyexcel-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyexcel%2Fpyexcel-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyexcel%2Fpyexcel-cli/lists"}