probullstats


Nameprobullstats JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryAn engine to pull data from the ProBullStats API.
upload_time2024-07-31 20:53:55
maintainerNone
docs_urlNone
authorGuy Hoozdis
requires_python<4.0,>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ========================
ProBullStats Data Engine
========================

|Ruff| |Test Status| |PyPI Version|

This is the ``probullstats`` package.  An engine to pull data from the `ProBullStats website`_
so that it can be collated with other relevant data and put into a standard format. Then clients
can use that data for any analysis or research they wish to pursue.


---------
IMPORTANT
---------

Unfettered Data Access Requires a Subscription.

- This package does not grant the user with any rights to access the curated data in the `ProBullStats database`_.
- Full Data access requires a subscription_ level that grants the rights to generate and use API keys to
  access the site's data.  See the website's `terms and service`__.
- The author of this package is not affiliated with the `ProBullStats website`_.

__ subscription_


Installation
============

Install the package into you desired environment.

::

   $ python3 -m pip install probullstats
   $ probullstats --help

**NOTE**: If you install the package into a virtual environment, then the CLI will only be available when that environment is active.



.. _ProBullStats website: https://probullstats.com
.. _ProBullStats database: https://probullstats.com/statstats.php
.. _subscription: https://probullstats.com/terms.php
.. _UBCoTx github: https://github.com/ubcotx
.. _UBCoTx website: https://ubcotx.com/

.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Ruff
.. |Test Status| image:: https://img.shields.io/github/actions/workflow/status/ubcotx/probullstats/ci-cd.yml?branch=main&label=Test%20Status&Logo=github
    :target: https://github.com/ubcotx/probullstats/actions/workflows/ci-cd.yml
    :alt: test-status
.. |PyPI Version| image:: https://img.shields/pypi/v/probullstats?label=PyPI&logo=pypi
    :target: https://pypi.org/project/probullstats/
    :alt: pypi

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "probullstats",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Guy Hoozdis",
    "author_email": "GuyHoozdis@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/42/3a/e4e850d94d4036d267afc1b36fe2710d1320270cb2601d30224fd81f9930/probullstats-0.2.0.tar.gz",
    "platform": null,
    "description": "========================\nProBullStats Data Engine\n========================\n\n|Ruff| |Test Status| |PyPI Version|\n\nThis is the ``probullstats`` package.  An engine to pull data from the `ProBullStats website`_\nso that it can be collated with other relevant data and put into a standard format. Then clients\ncan use that data for any analysis or research they wish to pursue.\n\n\n---------\nIMPORTANT\n---------\n\nUnfettered Data Access Requires a Subscription.\n\n- This package does not grant the user with any rights to access the curated data in the `ProBullStats database`_.\n- Full Data access requires a subscription_ level that grants the rights to generate and use API keys to\n  access the site's data.  See the website's `terms and service`__.\n- The author of this package is not affiliated with the `ProBullStats website`_.\n\n__ subscription_\n\n\nInstallation\n============\n\nInstall the package into you desired environment.\n\n::\n\n   $ python3 -m pip install probullstats\n   $ probullstats --help\n\n**NOTE**: If you install the package into a virtual environment, then the CLI will only be available when that environment is active.\n\n\n\n.. _ProBullStats website: https://probullstats.com\n.. _ProBullStats database: https://probullstats.com/statstats.php\n.. _subscription: https://probullstats.com/terms.php\n.. _UBCoTx github: https://github.com/ubcotx\n.. _UBCoTx website: https://ubcotx.com/\n\n.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n    :target: https://github.com/astral-sh/ruff\n    :alt: Ruff\n.. |Test Status| image:: https://img.shields.io/github/actions/workflow/status/ubcotx/probullstats/ci-cd.yml?branch=main&label=Test%20Status&Logo=github\n    :target: https://github.com/ubcotx/probullstats/actions/workflows/ci-cd.yml\n    :alt: test-status\n.. |PyPI Version| image:: https://img.shields/pypi/v/probullstats?label=PyPI&logo=pypi\n    :target: https://pypi.org/project/probullstats/\n    :alt: pypi\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "An engine to pull data from the ProBullStats API.",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "50b103a3d684709ab8eb359afab447b9ff3aee87b6bea7839817f6dc55837a7f",
                "md5": "511cd062d20bcec58863b8eccd3173d8",
                "sha256": "dc908e70da64b436101c67e040279d2e1b0632ecb95b8ab832e6f64cca5c26ec"
            },
            "downloads": -1,
            "filename": "probullstats-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "511cd062d20bcec58863b8eccd3173d8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 3454,
            "upload_time": "2024-07-31T20:53:54",
            "upload_time_iso_8601": "2024-07-31T20:53:54.722423Z",
            "url": "https://files.pythonhosted.org/packages/50/b1/03a3d684709ab8eb359afab447b9ff3aee87b6bea7839817f6dc55837a7f/probullstats-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "423ae4e850d94d4036d267afc1b36fe2710d1320270cb2601d30224fd81f9930",
                "md5": "5b616d16a8462260ca851a31374225fa",
                "sha256": "94b65864ac8e0bfbcab704d2a9e8f052b83a54160fbdffbb7948e6b24989c440"
            },
            "downloads": -1,
            "filename": "probullstats-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5b616d16a8462260ca851a31374225fa",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 2985,
            "upload_time": "2024-07-31T20:53:55",
            "upload_time_iso_8601": "2024-07-31T20:53:55.982854Z",
            "url": "https://files.pythonhosted.org/packages/42/3a/e4e850d94d4036d267afc1b36fe2710d1320270cb2601d30224fd81f9930/probullstats-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-31 20:53:55",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "probullstats"
}
        
Elapsed time: 0.30567s