{
    "info": {
        "author": "Jack Moody",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "Intended Audience :: Financial and Insurance Industry",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Topic :: Office/Business :: Financial :: Investment",
            "Topic :: Software Development :: Libraries :: Python Modules"
        ],
        "description": "Stock Score\n===========\n.. image:: https://img.shields.io/badge/python-v3-green.svg\n   :target: https://www.python.org\n\n.. image:: https://www.codefactor.io/repository/github/jackmoody11/stockscore/badge\n   :target: https://www.codefactor.io/repository/github/jackmoody11/stockscore\n\n.. image:: https://api.codacy.com/project/badge/Grade/d2108117522f4fe498530c6f7185108e\n   :target: https://www.codacy.com/project/jacklaytonmoody/stockscore/dashboard?utm_source=github.com&utm_medium=referral&utm_content=jackmoody11/stockScores&utm_campaign=Badge_Grade_Dashboard\n\n.. image:: https://travis-ci.com/jackmoody11/stockscore.svg?branch=master\n    :target: https://travis-ci.com/jackmoody11/stockscore\n\n.. image:: https://img.shields.io/github/license/mashape/apistatus.svg?style=popout\n   :target: https://github.com/jackmoody11/stockscore/blob/master/LICENSE\n\nStock Score is a python script to score stocks based on specified\ncriteria. The goal of this project is to provide a stock screening\nsystem for various types of stock classifications (growth, momentum, value, etc.).\n\nSimilar to how one might rank the best options when they are deciding\nwhere to go to dinner, Stock Score lets investors choose what screens\nthey want to run. Then, this script takes care of the rest,\nshowing which stocks performed best under the given screens.\n\nPrerequisites\n~~~~~~~~~~~~~\n\n- You can get the latest version of Python 3 here_ (this should come with the latest version of pip)\n- All dependencies are contained in `requirements.txt` (more on that directly below)\n\nGetting Started\n~~~~~~~~~~~~~~~\n\nTo clone this repository, run the following:\n::\n\n    git clone https://github.com/jackmoody11/stockscore\n\n\nChange working directory to project folder\n::\n\n    cd my/path/to/stockscore\n\nCreate a virtual environment\n::\n\n    python3 -m venv env\n\n\nActivate the virtual environment. See the docs_ for help.\n\nThen :code:`make init` to install required modules.\n\nRun the program!\n----------------\nTo make sure that everything is working, while in the working directory of the stockScore project, run :code:`python3 stockscore.py`.\n\n*Note*: Make sure you are using :code:`python3`.\nThis project does not support versions below Python 3.6 since it uses f strings.\nThis may change in the future to allow for earlier versions of Python to run.\n\nHere is an example output of what you can expect to see when you run the program:\n\nTerminal output:\n\n.. image:: /media/terminal_output.png\n\n\nTop 10 stocks output:\n\n.. image:: /media/StockScores.png\n\n\nRunning the tests\n-----------------\n\nAll tests can be run by simply running\n::\n\n    pytest\n\nIn order to run a specific test file (like test_fundamental_functions.py), run\n::\n\n    pytest tests/test_fundamental_functions.py\n\n\nTo run a specific test (like \"test_dividend_test_returns_scores\" in test_fundamental_screens.py), run\n::\n\n    pytest tests/test_fundamental_screens.py -k 'test_dividend_test_returns_scores'\n\n\nFor more information on how to use pytest (like how to select a few tests),\n`look here`_ for the official pytest docs.\n\nDeployment\n----------\n\nIn order to make code styling simple, this project uses black_. To make sure that this code adheres to this opinion based formatting, stockscore uses :code:`pre-commit`. In order to run black automatically before making a commit, please download :code:`pre-commit`.\n\nYou may need to run :code:`pre-commit install` before you are able to use this. For more details, check out the `pre-commit`_ website.\n\nThis project is very simple to deploy to a live system. To change which tests you are using, change which functions are added to the suites (this is the name used in both files) of :code:`fundamental_functions.py` and :code:`technical_functions.py`.\n\nBuilt With\n----------\n\nPython 3 and some great third party modules (see `requirements.txt`_ for full list).\n\nContributing\n------------\n\nPlease read the `code of conduct`_ for details on how to positively contribute to this project.\n\nVersioning\n----------\n\nThis project uses `SemVer`_ for versioning. For the versions available, see the\n`tags on this repository`_.\n\n\nLicense\n-------\n\nThis project is licensed under the MIT License - see the `LICENSE`_\nfile for details\n\nAcknowledgments\n---------------\n\n-  Hat tip to Benjamin Graham's *Intelligent Investor*. If you haven't already, read this book!\n-  Also, I recommend reading *Common Stocks and Uncommon Profits* by Philip Fisher.\n\nNotes\n-----\n\n- *Note that the screens included in this project are not exclusive and do not guarantee any sort of returns. I assume no liability for investment decisions you make and am not a professional adviser. Please do your due diligence before making investment decisions and consult with a professional as necessary.*\n\n\n\n.. _here: https://docs.python.org/3/installing/\n.. _docs: https://docs.python.org/3/library/venv.html\n.. _look here: https://pytestguide.readthedocs.io/en/latest/\n.. _Dropwizard: http://www.dropwizard.io/1.0.2/docs/\n.. _Maven: https://maven.apache.org/\n.. _ROME: https://rometools.github.io/rome/\n.. _black: https://github.com/ambv/black\n.. _pre-commit: https://pre-commit.com\n.. _`requirements.txt`: https://github.com/jackmoody11/stockScores/blob/master/requirements.txt\n.. _`code of conduct`: CODE_OF_CONDUCT.md\n.. _SemVer: http://semver.org/\n.. _tags on this repository: https://github.com/jackmoody11/stockScores/tags\n.. _LICENSE: https://github.com/jackmoody11/stockScores/blob/master/LICENSE",
        "description_content_type": "text/x-rst",
        "docs_url": null,
        "download_url": "https://github.com/jackmoody11/stockscore/releases",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/jackmoody11/stockscore",
        "keywords": "stocks market finance",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "stockscore",
        "package_url": "https://pypi.org/project/stockscore/",
        "platform": "",
        "project_url": "https://pypi.org/project/stockscore/",
        "project_urls": {
            "Download": "https://github.com/jackmoody11/stockscore/releases",
            "Homepage": "https://github.com/jackmoody11/stockscore"
        },
        "release_url": "https://pypi.org/project/stockscore/0.4.2/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "",
        "version": "0.4.2"
    },
    "last_serial": 5247509,
    "releases": {
        "0.4.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c5bb83b41aa1668bc506a4535ef33ae4",
                    "sha256": "d01c7be7b3b040af50277692d206e0e3ec53db962d1409b12e155e59befc9a89"
                },
                "downloads": -1,
                "filename": "stockscore-0.4.2.tar.gz",
                "has_sig": false,
                "md5_digest": "c5bb83b41aa1668bc506a4535ef33ae4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12679,
                "upload_time": "2019-05-09T13:31:31",
                "url": "https://files.pythonhosted.org/packages/49/49/09603df46c930412d27c114344436da9a95e7ee9f09b3a29af89751c0b42/stockscore-0.4.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "c5bb83b41aa1668bc506a4535ef33ae4",
                "sha256": "d01c7be7b3b040af50277692d206e0e3ec53db962d1409b12e155e59befc9a89"
            },
            "downloads": -1,
            "filename": "stockscore-0.4.2.tar.gz",
            "has_sig": false,
            "md5_digest": "c5bb83b41aa1668bc506a4535ef33ae4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 12679,
            "upload_time": "2019-05-09T13:31:31",
            "url": "https://files.pythonhosted.org/packages/49/49/09603df46c930412d27c114344436da9a95e7ee9f09b3a29af89751c0b42/stockscore-0.4.2.tar.gz"
        }
    ]
}