{
    "info": {
        "author": "C.W.",
        "author_email": "wangc_2011@hotmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2.6",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3.3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Topic :: Office/Business",
            "Topic :: Software Development :: Libraries",
            "Topic :: Utilities"
        ],
        "description": "================================================================================\r\nsphinxcontrib-excel - Let you focus on data, instead of file formats\r\n================================================================================\r\n\r\n.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png\r\n   :target: https://www.patreon.com/pyexcel\r\n\r\n.. image:: https://api.travis-ci.org/pyexcel/sphinxcontrib-excel.svg?branch=master\r\n   :target: http://travis-ci.org/pyexcel/sphinxcontrib-excel\r\n\r\n.. image:: https://codecov.io/github/pyexcel/sphinxcontrib-excel/coverage.png\r\n   :target: https://codecov.io/github/pyexcel/sphinxcontrib-excel\r\n\r\n\r\n\r\n**sphinxcontrib-excel** uses pyexcel to read an excel files and renders into an excel-alike sheet in your sphinx documentation. The excel file formats are:\r\n\r\n#. csv\r\n#. tsv\r\n#. csvz\r\n#. tsvz\r\n#. xls\r\n#. xlsx\r\n#. xlsm\r\n#. ods\r\n\r\n\r\n\r\n\r\nInstallation\r\n================================================================================\r\nYou can install it via pip:\r\n\r\n.. code-block:: bash\r\n\r\n    $ pip install sphinxcontrib-excel\r\n\r\n\r\nor clone it and install it:\r\n\r\n.. code-block:: bash\r\n\r\n    $ git clone https://github.com/pyexcel/sphinxcontrib-excel.git\r\n    $ cd sphinxcontrib-excel\r\n    $ python setup.py install\r\n\r\n\r\n\r\nSetup\r\n================================================================================\r\n\r\nPlease add sphinxcontrib-excel into your conf.py file::\r\n\r\n    extensions = [\r\n\t    ...\r\n\t    'sphinxcontrib.excel',\r\n\t    ...\r\n\t]\r\n\r\nAnd you will need to copy a few resources file to your sphinx source directory::\r\n\r\n    resources/_template/layout.html\r\n    resources/_static/handsontable.full.min.js\r\n    resources/_static/handsontable.full.min.css\r\n\r\n.. note::\r\n\r\n   `resources` directory is in github. please check it out.\r\n\r\nHere is the syntax to present your excel file in sphinx documentation::\r\n\r\n    .. pyexcel-table:: filename.csv\r\n\r\nAnd 'filename.csv' is expected in the directory where the referring rst file is.\r\nRelative path needs to be given if your file is somewhere else.\r\n\r\nFor example, the following rst statment:\r\n\r\n.. image:: https://github.com/pyexcel/sphinxcontrib-excel/raw/master/sphinx-doc-source.png\r\n   :alt: table directive\r\n\r\nis translated as:\r\n\r\n.. image:: https://github.com/pyexcel/sphinxcontrib-excel/raw/master/sphinx-doc-view.png\r\n   :alt: table view\r\n\r\nEmbed csv into your sphinx documentation\r\n--------------------------------------------------\r\n\r\nHere is the syntax for embedded csv `rendering as a single handsontable <http://pyexcel.readthedocs.io/en/latest/#usage>`_:\r\n\r\n.. code-block::\r\n\r\n   .. pyexcel-table::\r\n\r\n      ---pyexcel:example table---\r\n      Name,Age\r\n      Adam,28\r\n      Beatrice,29\r\n      Ceri,30\r\n      Dean,26  \r\n\r\nHere is the complex example for embedded csv, which will be `rendered as\r\nmulti-tab handsontable <http://pyexcel.readthedocs.io/en/latest/tutorial_data_conversion.html#how-to-obtain-a-dictionary-from-a-multiple-sheet-book>`_):\r\n\r\n.. code-block::\r\n\r\n   .. pyexcel-table::\r\n\r\n      ---pyexcel:Sheet 1---\r\n      1,2,3\r\n      4,5,6\r\n      7,8,9\r\n      ---pyexcel---\r\n      ---pyexcel:Sheet 2---\r\n      X,Y,Z\r\n      1,2,3\r\n      4,5,6\r\n      ---pyexcel---\r\n      ---pyexcel:Sheet 3---\r\n      O,P,Q\r\n      3,2,1\r\n      4,3,2\r\n\r\n\r\n\r\nSupport the project\r\n================================================================================\r\n\r\nIf your company has embedded pyexcel and its components into a revenue generating\r\nproduct, please `support me on patreon <https://www.patreon.com/bePatron?u=5537627>`_ to\r\nmaintain the project and develop it further.\r\n\r\nIf you are an individual, you are welcome to support me too on patreon and for however long\r\nyou feel like to. As a patreon, you will receive\r\n`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.\r\n\r\nWith your financial support, I will be able to invest\r\na little bit more time in coding, documentation and writing interesting posts.\r\n\r\n\r\nDevelopment guide\r\n================================================================================\r\n\r\nDevelopment steps for code changes\r\n\r\n#. git clone https://github.com/pyexcel/sphinxcontrib-excel.git\r\n#. cd sphinxcontrib-excel\r\n\r\nUpgrade your setup tools and pip. They are needed for development and testing only:\r\n\r\n#. pip install --upgrade setuptools pip\r\n\r\nThen install relevant development requirements:\r\n\r\n#. pip install -r rnd_requirements.txt # if such a file exists\r\n#. pip install -r requirements.txt\r\n#. pip install -r tests/requirements.txt\r\n\r\n\r\nIn order to update test environment, and documentation, additional steps are\r\nrequired:\r\n\r\n#. pip install moban\r\n#. git clone https://github.com/pyexcel/pyexcel-commons.git commons\r\n#. make your changes in `.moban.d` directory, then issue command `moban`\r\n\r\nWhat is rnd_requirements.txt\r\n-------------------------------\r\n\r\nUsually, it is created when a dependent library is not released. Once the dependecy is installed(will be released), the future version of the dependency in the requirements.txt will be valid.\r\n\r\nWhat is pyexcel-commons\r\n---------------------------------\r\n\r\nMany information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in `pyexcel-commons` project.\r\n\r\nWhat is .moban.d\r\n---------------------------------\r\n\r\n`.moban.d` stores the specific meta data for the library.\r\n\r\nHow to test your contribution\r\n------------------------------\r\n\r\nAlthough `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.\r\n\r\nOn Linux/Unix systems, please launch your tests like this::\r\n\r\n    $ make\r\n\r\nOn Windows systems, please issue this command::\r\n\r\n    > test.bat\r\n\r\n\r\nLicense\r\n================================================================================\r\n\r\nNew BSD License",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "UNKNOWN",
        "keywords": "excel,python,pyexcel",
        "license": "New BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "sphinxcontrib-excel",
        "package_url": "https://pypi.org/project/sphinxcontrib-excel/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/sphinxcontrib-excel/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "UNKNOWN"
        },
        "release_url": "https://pypi.org/project/sphinxcontrib-excel/0.0.1/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Embed excel file as an excel-alike table into sphinx documentation.",
        "version": "0.0.1"
    },
    "last_serial": 2973200,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f6844823c7e29ca40969fbb577e6aeca",
                    "sha256": "5ae7a5d57953d91bf0c8a8b7eeba6b97afb4b79ea47493d77989e032639e9da1"
                },
                "downloads": -1,
                "filename": "sphinxcontrib_excel-0.0.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f6844823c7e29ca40969fbb577e6aeca",
                "packagetype": "bdist_wheel",
                "python_version": "2.7",
                "requires_python": null,
                "size": 7499,
                "upload_time": "2017-06-21T09:57:31",
                "url": "https://files.pythonhosted.org/packages/61/0c/41a79554f7da024b8db6d94737dd76a03f9ca168ad372e5d23d3609a1ef5/sphinxcontrib_excel-0.0.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "0445a4c45660f8c8a139c45cfb0d8717",
                    "sha256": "ac052abb2b3f3687ad196749df54d4b0202f9b1200678d13ad46ea62cd8f46f9"
                },
                "downloads": -1,
                "filename": "sphinxcontrib-excel-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "0445a4c45660f8c8a139c45cfb0d8717",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5247,
                "upload_time": "2017-06-21T09:57:29",
                "url": "https://files.pythonhosted.org/packages/85/2d/485910497f77724e7492c5324ede43d24b3fba6f051d6a44c22f924154d1/sphinxcontrib-excel-0.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f6844823c7e29ca40969fbb577e6aeca",
                "sha256": "5ae7a5d57953d91bf0c8a8b7eeba6b97afb4b79ea47493d77989e032639e9da1"
            },
            "downloads": -1,
            "filename": "sphinxcontrib_excel-0.0.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f6844823c7e29ca40969fbb577e6aeca",
            "packagetype": "bdist_wheel",
            "python_version": "2.7",
            "requires_python": null,
            "size": 7499,
            "upload_time": "2017-06-21T09:57:31",
            "url": "https://files.pythonhosted.org/packages/61/0c/41a79554f7da024b8db6d94737dd76a03f9ca168ad372e5d23d3609a1ef5/sphinxcontrib_excel-0.0.1-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "0445a4c45660f8c8a139c45cfb0d8717",
                "sha256": "ac052abb2b3f3687ad196749df54d4b0202f9b1200678d13ad46ea62cd8f46f9"
            },
            "downloads": -1,
            "filename": "sphinxcontrib-excel-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0445a4c45660f8c8a139c45cfb0d8717",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5247,
            "upload_time": "2017-06-21T09:57:29",
            "url": "https://files.pythonhosted.org/packages/85/2d/485910497f77724e7492c5324ede43d24b3fba6f051d6a44c22f924154d1/sphinxcontrib-excel-0.0.1.tar.gz"
        }
    ]
}