{
    "info": {
        "author": "Robert Rennison",
        "author_email": "rob@robren.net",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 2 - Pre-Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: Apache Software License",
            "Natural Language :: English",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6"
        ],
        "description": "================\nquandl_fund_xlsx\n================\n\n\n.. image:: https://img.shields.io/pypi/v/quandl_fund_xlsx.svg\n        :target: https://pypi.python.org/pypi/quandl_fund_xlsx\n\n.. image:: https://img.shields.io/travis/robren/quandl_fund_xlsx.svg\n        :target: https://travis-ci.org/robren/quandl_fund_xlsx\n\n.. image:: https://readthedocs.org/projects/quandl_fund_xlsx/badge/?version=latest\n        :target: https://quandl_fund_xlsx.readthedocs.io/en/latest/?badge=latest\n        :alt: Documentation Status\n\n.. image:: https://pyup.io/repos/github/robren/quandl_fund_xlsx/shield.svg\n     :target: https://pyup.io/repos/github/robren/quandl_fund_xlsx/\n     :alt: Updates\n\n\nA unofficial CLI tool which uses the Quandl API and the Sharadar Essential Fundamentals\nDatabase to extract financial fundamentals, Sharadar provided ratios as\nwell as calculate additional ratios. Results are\nwritten to an Excel Workbook with a separate worksheet per ticker analysed.\n\n* Free software: Apache Software License 2.0\n* Documentation: https://quandl_fund_xlsx.readthedocs.io.\n\n\nFeatures\n--------\n\nFor a given ticker, fundamental data is obtained using the Quandl API and the\nSharadar Fundamentals database. This data is then used to calculate various\nuseful, financial ratios. The ratios  include \n\n- Profitability indicators\n- Financial leverage indicators\n- Free and Operating Cash flow indicators.\n\nSome REIT specific ratios such as FFO are very roughly approximated.\nThese specific ratios are only roughly approximated since certain data, namely\nReal estate sales data for the period does not appear to be available via the\nAPI (It's often buried in the footnotes of these companies filings).\n\n\nThe output excel worksheet for each ticker processed is divided into three main areas:\n\n- Sharadar statement indicators. This is data obtained from the three main\n  financial statements; the Income Statement, the Balance Sheet and the Cash Flow\n  Statement. \n\n- Sharadar Metrics and Ratio Indicators. These are quandl provided financial ratios.\n\n- Calculated Metrics and Ratios. These are calculated by the package from the\n  Sharadars data provided and tabulated by the statement indicators and the\n  'Metrics and Ratio' indicators.\n\nThe python Quandl API provides the ability to return data within python pandas\ndataframes. This makes calculating various ratios as simple as dividing two\nvariables by each other.\n\nThe calculations support the data offered by the free sample \ndatabase (formerly referred to by Sharadar as the SF0 database), and the paid for `SF1\n<https://www.quandl.com/data/SF1-Core-US-Fundamentals-Data/documentation/dimensions>`_\ndatabase. The coverage universe is the same for both the sample data and the\npaid database. The key diference being, support as well as a much richer set\nof so-called Dimensions.\n\n.. figure:: docs/Tech-1.png\n   :scale: 25\n   \n   The generated Excel workbook with one sheet per ticker.\n\n.. figure:: docs/Tech-2.png\n   :scale: 25\n   \n   Some bespoke metrics and ratios calculated based on Sharadar fundamentals.\n\nInstallation\n------------\n\n.. code:: bash\n\n    pip install quandl_fund_xlsx\n\nConfiguration\n-------------\nIf you have have a key for the free sample data set the  QUANDL_API_SF0_KEY\nenvironment variable. If you have paid access to the full range of\nfundamentals data set the QUANDL_API_SF1_KEY in the environment.\n\n.. code:: bash\n\n   export QUANDL_API_SF0_KEY='YourQuandlAPIKey'\n   \n   or\n\n   export QUANDL_API_SF1_KEY='YourQuandlAPIKey'\n\n\nUsage\n-----\n.. code:: bash\n\n\tquandl_fund_xlsx -h\n\tquandl_fund_xlsx\n\n\tUsage:\n\tquandl_fund_xlsx (-i <ticker-file> | -t <ticker>) [-o <output-file>]\n\t\t\t\t\t\t\t\t\t[-y <years>] [-d <sharadar-db>]\n                                    [--dimension <dimension>]\n\n\tquandl_fund_xlsx.py (-h | --help)\n\tquandl_fund_xlsx.py --version\n\n\tOptions:\n\t-h --help             Show this screen.\n\t-i --input <file>     File containing one ticker per line\n\t-t --ticker <ticker>  Ticker symbol\n\t-o --output <file>    Output file [default: stocks.xlsx]\n\t-y --years <years>    How many years of results (max 7 with SF0) [default: 5]\n\t-d --database <database>    Sharadar Fundamentals database to use, SFO or\n\t\t\t\t\t\t\t\tSF1 [default: SF0]\n        --dimension <dimension>     Sharadar database dimension, ARY, MRY, ART, MRT [default: MRY]\n\t--version             Show version.\n\n\n.. code:: bash\n\n\tquandl_fund_xlsx -t INTC -o intc-MRY.xlsx\n\t{'--database': 'SF0',\n\t'--input': None,\n\t'--output': 'INTC-MRY.xlsx',\n\t'--ticker': 'INTC',\n\t'--years': '5'}\n\t('Ticker =', 'INTC')\n\t2017-08-22 06:08:59,751 INFO     Processing the stock INTC\n\t2017-08-22 06:09:06,012 INFO     Processed the stock INTC\n\n\tls -lh excel_files\n\ttotal 12K\n\t-rw-rw-r-- 1 test test 8.7K Aug 22 06:09 intc-MRY.xlsx\n\nLocal Development\n-----------------\n\nIt's recommended to setup a virtual environment and perform the installation\nwithin this. Use  pip to install the requirements but not the\npackage.\n\n.. code:: bash\n\n    pip install -r requirements_dev.txt\n\n    # Run the CLI by running as a module\n    python -m quandl_fund_xlsx.cli -t MSFT\n\n    # Run the tests\n    pytest\n\nIf you wish to install the package locally within either a virtualenv or\nglobally this can be done once again using pip.\n\n.. code:: bash\n\n    pip install -e .\n\n    # Now the CLI is installed within our environment and should be on the\n    # path\n    quandl_fund_xlsx -t MSFT\n\nHow to get help contribute or provide feedback\n----------------------------------------------\n\nSee the `contribution submission and feedback guidelines <ref-contributing>`\n\nCredits\n---------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n\n=======\nHistory\n=======\n\n0.1.1 (2017-08-31)\n------------------\n\n* First release on PyPI.\n\n0.1.2 (2017-08-31)\n------------------\n* Change logging to INFO from DEBUG\n\n0.1.3 (2017-08-31)\n------------------\n* Minor tweak to Return the correct version\n\n0.1.4 (2017-11-06)\n------------------\n* Removed the --dimension CLI keyword. \n  Now uses Most Recent Year (MRY) for SF0 database\n  and Most Recent Trailing 12 Months (MRT) for the SF1 database\n* Fix to avoid the Pandas future warning about decrementing\n  df.rename_axis and using df.rename\n\n0.1.6 (2018-01-26)\n-------------------\nNow uses the get_table methods from the quandl_api. \n\n0.1.7 (2018-05-10)\n-------------------\n* Fix bug where the dataframe returned from quandl qas not being sorted\n* Added EPS and EPS diluted.\n\n0.1.8 ( 2018-05-24)\n-------------------\n* Fix bug where the SF0 subscription data was not being returned.\n* With the discontinuation of the Sharadar Time series API at the end of March\n  2018, the codes for the free fundamental subscription SF0 database changed.\n  Subscribers to the SF0 data now use the SHARADAR/SF1 code in the get_table\n  accesses.\n\n0.1.9 ( 2018-06-11)\n-------------------\n* Added back support for the --dimension CLI option.\n\n0.1.10 (2018-10-29)    \n-------------------\n* Added some  new Cash Flow related ratios and corrected the LTDEBT ratios\n* Changed the default to be the paid SF1 Database as this is the one I'm using\n  and testing. Requires a separate free SF0 subscription to test SFO. All of\n  the API calls whether the user has an SFI paid membership or SF0 use the\n  SF1 codes.\n\n\n0.2.0 (2018-11-13)    \n-------------------\n* After learning that the sample data API now allows _all_ of the same\n  indicators as those available using the paid SF! aPI key I was able to\n  remove a lot of special case code for the Sample data KEY. \n  The paid KEY allows for many more dimensions to be queried.\n* The CLI now defaults back to using the sample data SF0 API key.\n* Added a number of Cash Flow from Operations  based metrics as well as some \n  Free Cash Flow based metrics.\n* Added a development test which uses the API and a sample data or SF0 API key \n  to extract ratios for AAPL.\n* Added Excess Cash Margin ratio.\n\n0.2.1 (2018-11-13)    \n-------------------\n* Minor security fix, requests version now >=2.20.0\n*  Minor documentation cleanup\n\n\n0.2.2 (2018-11-13)    \n-------------------\n* Add support for the MRQ and ARQ dimensions.\n* Correct error in calculating CAGR when the data was given in quarterly increments.\n* Correctly reference the Excel spreadsheet example figures in the README.\n\n0.2.3 (2018-12-29)    \n-------------------\n* Check for the presence of the QUANDL_API_SF0_KEY or the QUANDL_API_SF1_KEY \n  environment variable  depending on which database the user is requesting to use.\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/robren/quandl_fund_xlsx",
        "keywords": "quandl_fund_xlsx quandl finance",
        "license": "Apache Software License 2.0",
        "maintainer": "",
        "maintainer_email": "",
        "name": "quandl_fund_xlsx",
        "package_url": "https://pypi.org/project/quandl_fund_xlsx/",
        "platform": "",
        "project_url": "https://pypi.org/project/quandl_fund_xlsx/",
        "project_urls": {
            "Homepage": "https://github.com/robren/quandl_fund_xlsx"
        },
        "release_url": "https://pypi.org/project/quandl_fund_xlsx/0.2.3/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "A CLI tool using the Quandl API and the Sharadar Fundamentals database.",
        "version": "0.2.3"
    },
    "last_serial": 4645099,
    "releases": {
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b263ccb5b26ee5ae327adfaeecf383d8",
                    "sha256": "ec038d48ae6a644c55f00fa54f6841c4263e53c2d205f5b437809cd1340fb74b"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "b263ccb5b26ee5ae327adfaeecf383d8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 204160,
                "upload_time": "2017-09-01T03:00:09",
                "url": "https://files.pythonhosted.org/packages/17/8d/6930846b856ad2bb57eb0fa380e14b133fef427206c622ac1d32a48e4e9d/quandl_fund_xlsx-0.1.1.tar.gz"
            }
        ],
        "0.1.10": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d827e226390f196aea46ef254c626e24",
                    "sha256": "dabd38af42498d4e709e00c70031547db8f879ce8937de399c0bd97c84675e3e"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.1.10.tar.gz",
                "has_sig": false,
                "md5_digest": "d827e226390f196aea46ef254c626e24",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 209710,
                "upload_time": "2018-10-30T01:14:07",
                "url": "https://files.pythonhosted.org/packages/f4/b2/6f622ac1c54aa58819542716a31038d991c5e16a56ad97d78e458e693644/quandl_fund_xlsx-0.1.10.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2f2f1a3db6a9ff26f39a8766cc854aad",
                    "sha256": "2793e3b46fca25726176311f0f76fdd759586b4c1eaa5f0010d0a92f0b1bec5b"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "2f2f1a3db6a9ff26f39a8766cc854aad",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 204190,
                "upload_time": "2017-09-01T03:20:59",
                "url": "https://files.pythonhosted.org/packages/3f/69/f9062018f80b92ee2ef51ed9961aca00cdc601e113175a8c9f1744e13408/quandl_fund_xlsx-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c97d9b1b00c2741f6cab844694157cd4",
                    "sha256": "9dc468ced6e14a97bb526e99d28eda9f2e910e5813d367460567246b83e62e9c"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "c97d9b1b00c2741f6cab844694157cd4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 204173,
                "upload_time": "2017-09-01T03:32:03",
                "url": "https://files.pythonhosted.org/packages/e5/a1/f3c7545903603aa84abac2390b54b709fbaecf47938bfb87ae7add1517aa/quandl_fund_xlsx-0.1.3.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "64139c03a41bc4d151283ef751e5ce86",
                    "sha256": "bc2864cbd84113959d4ada7ecc4a84039599b951aa7fe65631022e0d8e72a443"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.1.4-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "64139c03a41bc4d151283ef751e5ce86",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 15690,
                "upload_time": "2017-11-06T15:56:09",
                "url": "https://files.pythonhosted.org/packages/72/2d/654a69b77ebdcec6d001c5b0f24ae077d1ec84a2ee7b24f00b7196003b0e/quandl_fund_xlsx-0.1.4-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "63d8cb494a0dee58c66e91f46f9ed045",
                    "sha256": "47de428299408854d08a75d26f16adeb106395fa3137b084788452b9447abf48"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "63d8cb494a0dee58c66e91f46f9ed045",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 205943,
                "upload_time": "2017-11-06T15:42:03",
                "url": "https://files.pythonhosted.org/packages/52/a9/83514b8f9dc67752107b5e986502dbde657e5f9cf6695f27d7247d1ffb37/quandl_fund_xlsx-0.1.4.tar.gz"
            }
        ],
        "0.1.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "10185d202fb9c1aceb3ad8ab8dd19ec8",
                    "sha256": "3c210bc71c7e1874879d903494b277e9ce72ab59ab9aac8aec76c7e844403f63"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.1.6.tar.gz",
                "has_sig": false,
                "md5_digest": "10185d202fb9c1aceb3ad8ab8dd19ec8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 206448,
                "upload_time": "2018-01-26T16:42:43",
                "url": "https://files.pythonhosted.org/packages/aa/4c/5d4a795855b23cc786bcc1a8d6e41b9a5ef9c8638e4823b0b41a4e44c15a/quandl_fund_xlsx-0.1.6.tar.gz"
            }
        ],
        "0.1.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b99c9519b6133a393b88cbfeac4d353d",
                    "sha256": "7f632d949ffe5805df1f1479144479d21a8638602be495ed6a6a0cc1349efe04"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.1.7.tar.gz",
                "has_sig": false,
                "md5_digest": "b99c9519b6133a393b88cbfeac4d353d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 207045,
                "upload_time": "2018-05-10T20:25:14",
                "url": "https://files.pythonhosted.org/packages/b1/8c/9d61066dc0b4ac29fda11cf245902e6719a311d1da187ee846558e8e3701/quandl_fund_xlsx-0.1.7.tar.gz"
            }
        ],
        "0.1.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "671a80b20e25d1856f17ff9dddc6adb3",
                    "sha256": "fabbe5fd623f71312d97107bdbd6c1026dfc33cebfd010e1a837742e3b1845d6"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.1.8.tar.gz",
                "has_sig": false,
                "md5_digest": "671a80b20e25d1856f17ff9dddc6adb3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 207617,
                "upload_time": "2018-05-25T05:05:46",
                "url": "https://files.pythonhosted.org/packages/37/7a/f262c745534471c9361350e0b1b11e25f115adf8dd94cd19c67f2d9f7766/quandl_fund_xlsx-0.1.8.tar.gz"
            }
        ],
        "0.1.9": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "30284a165f25a963a6ebb773c3966cae",
                    "sha256": "c8b6280af35048f99f558a0dac7ff24624f9c7938b511551e4775599cf6d6877"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.1.9.tar.gz",
                "has_sig": false,
                "md5_digest": "30284a165f25a963a6ebb773c3966cae",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 205789,
                "upload_time": "2018-08-23T18:31:23",
                "url": "https://files.pythonhosted.org/packages/23/7e/0145076b894d87566083ae119216d01798ad8b0420217b0574062e399e29/quandl_fund_xlsx-0.1.9.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "75ebda22d0cd82cb682aba5a539a0313",
                    "sha256": "9328b1483ee82d1eab9d689fdc37bb354fbb7ab565856e3a3b994c191b497ac1"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "75ebda22d0cd82cb682aba5a539a0313",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 226293,
                "upload_time": "2018-11-13T19:18:51",
                "url": "https://files.pythonhosted.org/packages/64/aa/ddcd16e20e7bdcc00407014bfa37bd7d887081ba2c7af78c313925003ad3/quandl_fund_xlsx-0.2.0.tar.gz"
            }
        ],
        "0.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "549683d19f4c0f836be94d9c3c141e21",
                    "sha256": "cb4c909332c84761a88257b232aefbcf2a5da6c3f4b7883435b9393bf0022cc8"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "549683d19f4c0f836be94d9c3c141e21",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 226231,
                "upload_time": "2018-11-13T19:42:48",
                "url": "https://files.pythonhosted.org/packages/1f/80/63e081ed281cc9d1dd7b01d248d1a8086815c92171e9430e84ce8b7fca13/quandl_fund_xlsx-0.2.1.tar.gz"
            }
        ],
        "0.2.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "bad3387f8a97ae3a74ea5aed1c71ebf9",
                    "sha256": "3f059fedefb827dfc27d9d1037739fdac86168dae5336b5ada2f0071ef73756b"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.2.2.tar.gz",
                "has_sig": false,
                "md5_digest": "bad3387f8a97ae3a74ea5aed1c71ebf9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 333467,
                "upload_time": "2018-11-14T03:34:56",
                "url": "https://files.pythonhosted.org/packages/fe/9e/1549c628314ed379e8265e847f96a2783828f53204904d4511e22dd64f3d/quandl_fund_xlsx-0.2.2.tar.gz"
            }
        ],
        "0.2.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f059df3f1ce6aa8ccf067570ade52ae5",
                    "sha256": "fe976cd13c57a68537b2e3b8cc121bca33749395846a426907ada7a056a13add"
                },
                "downloads": -1,
                "filename": "quandl_fund_xlsx-0.2.3.tar.gz",
                "has_sig": false,
                "md5_digest": "f059df3f1ce6aa8ccf067570ade52ae5",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 333509,
                "upload_time": "2018-12-30T02:04:44",
                "url": "https://files.pythonhosted.org/packages/ab/42/af0a41695655f998b7f6e33914b61bb497bce51f9544eeca999a89f5d56b/quandl_fund_xlsx-0.2.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f059df3f1ce6aa8ccf067570ade52ae5",
                "sha256": "fe976cd13c57a68537b2e3b8cc121bca33749395846a426907ada7a056a13add"
            },
            "downloads": -1,
            "filename": "quandl_fund_xlsx-0.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "f059df3f1ce6aa8ccf067570ade52ae5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 333509,
            "upload_time": "2018-12-30T02:04:44",
            "url": "https://files.pythonhosted.org/packages/ab/42/af0a41695655f998b7f6e33914b61bb497bce51f9544eeca999a89f5d56b/quandl_fund_xlsx-0.2.3.tar.gz"
        }
    ]
}