finra-py 1.0.0__tar.gz

finra_py-1.0.0/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2026 Hawk Berry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

finra_py-1.0.0/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: finra-py
+Version: 1.0.0
+Summary: An Unofficial, Open-Source Python Client Library for the FINRA API Platform
+Author-email: Hawk Berry <finra@hawkberry.com>
+License: The MIT License (MIT)
+        
+        Copyright © 2026 Hawk Berry
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: Homepage, https://finra.hawkberry.com/en/latest/
+Project-URL: Documentation, https://finra.hawkberry.com/en/latest/
+Project-URL: Repository, https://github.com/hawkberry/finra-py
+Project-URL: Changelog, https://github.com/hawkberry/finra-py/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/hawkberry/finra-py/issues
+Keywords: finra,finra-api,api-client,rest-api,market-data,compliance,regulatory,regtech,broker-dealer,trading,fixed-income,short-interest,trace
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: authlib
+Requires-Dist: httpx
+Requires-Dist: jsonschema
+Requires-Dist: tzdata
+Provides-Extra: docs
+Requires-Dist: sphinx==9.1.0; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints==3.6.3; extra == "docs"
+Requires-Dist: pydata-sphinx-theme==0.19.0; extra == "docs"
+Provides-Extra: lint
+Requires-Dist: ruff==0.15.2; extra == "lint"
+Provides-Extra: stats
+Requires-Dist: pycodestats; extra == "stats"
+Provides-Extra: test
+Requires-Dist: colorama==0.4.6; extra == "test"
+Requires-Dist: coverage==7.14.2; extra == "test"
+Provides-Extra: tox
+Requires-Dist: tox==4.49.1; extra == "tox"
+Provides-Extra: types
+Requires-Dist: mypy==1.19.1; extra == "types"
+Requires-Dist: types-Authlib==1.6.8.20260215; extra == "types"
+Requires-Dist: types-colorama==0.4.15.20260508; extra == "types"
+Requires-Dist: types-jsonschema==4.26.0.20260518; extra == "types"
+Provides-Extra: dev
+Requires-Dist: finra[docs,lint,stats,test,tox,types]; extra == "dev"
+Dynamic: license-file
+
+============================================
+``finra-py``: An Unofficial FINRA API Client
+============================================
+
+.. image:: https://github.com/hawkberry/finra-py/actions/workflows/run-tests.yml/badge.svg
+  :target: https://github.com/hawkberry/finra-py/actions/workflows/run-tests.yml
+
+.. image:: https://codecov.io/github/hawkberry/finra-py/coverage.svg?branch=main
+  :target: https://codecov.io/github/hawkberry/finra-py?branch=main
+
+.. image:: https://readthedocs.org/projects/finra-py/badge/?version=latest
+  :target: https://finra.hawkberry.com/en/latest/?badge=latest
+
+.. image:: https://badge.fury.io/py/finra-py.svg
+  :target: https://badge.fury.io/py/finra-py
+
+.. image:: https://img.shields.io/pypi/pyversions/finra-py.svg
+   :target: https://pypi.org/project/finra-py/
+
+.. image:: https://img.shields.io/pypi/l/finra-py.svg
+   :target: https://github.com/hawkberry/finra-py/blob/main/LICENSE
+
+.. image:: https://img.shields.io/badge/Support-blue
+   :target: https://support.hawkberry.com/
+
++++++++++++++++++++++
+What is ``finra-py``?
++++++++++++++++++++++
+
+``finra-py`` is an unofficial, open-source Python client library for the `FINRA API Platform <https://developer.finra.org/products>`__. It is designed to be as thin and unopinionated as possible, offering an elegant programmatic interface to every endpoint and dataset.
+
+Notable functionality includes:
+ 
+ - Authentication and client creation
+ - Equity, Fixed Income, FINRA, Firm, Registration and TRACE Report Card datasets via the `Query API <https://finra.hawkberry.com/en/latest/query-api.html>`__
+ - Notification datasets via the `Notification API <https://finra.hawkberry.com/en/latest/notification-api.html>`__
+ - Submission of regulatory filings and other data to FINRA via the `Submission API <https://finra.hawkberry.com/en/latest/submission-api.html>`__
+ - Support for the Mock API
+ - Support for the QA Test Environment API
+ - Support for all credential types
+ - Support for asynchronous requests (server-side)
+ - Support for ``asyncio`` (client-side)
+ 
+Python requirement: **3.11 or later**
+
+++++++++++++++++++++++++++
+How do I use ``finra-py``?
+++++++++++++++++++++++++++
+
+You can find a full description of the ``finra-py`` library's functionality in the `documentation <https://finra.hawkberry.com/en/latest/>`__.
+
+For detailed instructions on how to get started with ``finra-py``, see `Getting Started <https://finra.hawkberry.com/en/latest/getting-started.html>`__.
+
+++++++++++++++++++++++++++++++
+Why should I use ``finra-py``?
+++++++++++++++++++++++++++++++
+
+``finra-py`` is designed to provide a few important pieces of functionality:
+
+1. **Safe Authentication**: The FINRA API Platform authentication and authorization scheme is based on OAuth 2.0. However, too many people online end up rolling their own implementation of the OAuth 2.0 authentication flow, which is both unnecessarily complex and dangerous. ``finra-py`` handles the token fetch and management for you.
+
+2. **Minimal API Wrapping**: Unlike some other API wrappers, which build in lots of opinionated logic and validation, ``finra-py`` takes raw values and returns raw responses, allowing you to interpret the complex API responses as you see fit. Anything you can do with raw HTTP requests you can do with ``finra-py``, only more easily.
+
+3. **All API Endpoints**: The ``finra-py`` library is designed to provide thorough coverage of the FINRA API Platform. With this goal in mind, ``finra-py`` implements full functionality for every dataset and regulatory filing supported by the FINRA API and described in the documentation.
+
++++++++++++
+Limitations
++++++++++++
+
+``finra-py`` strives to provide comprehensive coverage of all documented datasets for the FINRA API. However, there are some datasets and services available through FINRA that may not be available through the FINRA API. See `FINRA Data <https://www.finra.org/finra-data>`__ for information about all available FINRA datasets.
+
+ - ``finra-py`` does not currently support FINRA's fileX API
+ 
+++++++++++++++++++++
+Help and Development
+++++++++++++++++++++
+
+For troubleshooting guidance and answers to common questions, see the
+`Getting Help <https://finra.hawkberry.com/en/latest/help.html>`__ page.
+
+Submit bug reports on the ``finra-py`` `Issues Page <https://github.com/hawkberry/finra-py/issues>`__ on GitHub.
+
+If you need a dataset or feature that is not currently supported by the client, please file a `Feature Request <https://github.com/hawkberry/finra-py/issues>`__. Pull requests are not currently accepted.
+
+++++++++++++++++++++
+FINRA API Consulting
+++++++++++++++++++++
+
+Need help implementing the FINRA API?
+
+As the author and maintainer of ``finra-py``, I provide consulting on FINRA API integrations, Web EFT migrations, compliance-related workflows, and market data systems.
+
+See the `consulting page <https://finra.hawkberry.com/en/latest/consulting.html>`__ for more information.
+
++++++++++++++
+Project Links
++++++++++++++
+
+* `Documentation <https://finra.hawkberry.com/en/latest/>`__
+* `Repository <https://github.com/hawkberry/finra-py>`__
+* `PyPI <https://pypi.org/project/finra-py/>`__
+* `Changelog <https://github.com/hawkberry/finra-py/blob/main/CHANGELOG.md>`__
+* `Consulting <https://finra.hawkberry.com/en/latest/consulting.html>`__
+* `Support <https://support.hawkberry.com/>`__
+* `Issues <https://github.com/hawkberry/finra-py/issues>`__
+
+**Disclaimer:** ``finra-py`` *is an unofficial, open-source client library for the FINRA API. It is not endorsed by, affiliated with, or sponsored by FINRA or any associated organization. Users are responsible for reviewing and complying with the terms of service and usage requirements of the underlying FINRA API. This software is provided under the terms of the* `LICENSE <https://github.com/hawkberry/finra-py/blob/main/LICENSE>`__ *without warranty of any kind.*
+

finra_py-1.0.0/README.rst

@@ -0,0 +1,108 @@
+============================================
+``finra-py``: An Unofficial FINRA API Client
+============================================
+
+.. image:: https://github.com/hawkberry/finra-py/actions/workflows/run-tests.yml/badge.svg
+  :target: https://github.com/hawkberry/finra-py/actions/workflows/run-tests.yml
+
+.. image:: https://codecov.io/github/hawkberry/finra-py/coverage.svg?branch=main
+  :target: https://codecov.io/github/hawkberry/finra-py?branch=main
+
+.. image:: https://readthedocs.org/projects/finra-py/badge/?version=latest
+  :target: https://finra.hawkberry.com/en/latest/?badge=latest
+
+.. image:: https://badge.fury.io/py/finra-py.svg
+  :target: https://badge.fury.io/py/finra-py
+
+.. image:: https://img.shields.io/pypi/pyversions/finra-py.svg
+   :target: https://pypi.org/project/finra-py/
+
+.. image:: https://img.shields.io/pypi/l/finra-py.svg
+   :target: https://github.com/hawkberry/finra-py/blob/main/LICENSE
+
+.. image:: https://img.shields.io/badge/Support-blue
+   :target: https://support.hawkberry.com/
+
++++++++++++++++++++++
+What is ``finra-py``?
++++++++++++++++++++++
+
+``finra-py`` is an unofficial, open-source Python client library for the `FINRA API Platform <https://developer.finra.org/products>`__. It is designed to be as thin and unopinionated as possible, offering an elegant programmatic interface to every endpoint and dataset.
+
+Notable functionality includes:
+ 
+ - Authentication and client creation
+ - Equity, Fixed Income, FINRA, Firm, Registration and TRACE Report Card datasets via the `Query API <https://finra.hawkberry.com/en/latest/query-api.html>`__
+ - Notification datasets via the `Notification API <https://finra.hawkberry.com/en/latest/notification-api.html>`__
+ - Submission of regulatory filings and other data to FINRA via the `Submission API <https://finra.hawkberry.com/en/latest/submission-api.html>`__
+ - Support for the Mock API
+ - Support for the QA Test Environment API
+ - Support for all credential types
+ - Support for asynchronous requests (server-side)
+ - Support for ``asyncio`` (client-side)
+ 
+Python requirement: **3.11 or later**
+
+++++++++++++++++++++++++++
+How do I use ``finra-py``?
+++++++++++++++++++++++++++
+
+You can find a full description of the ``finra-py`` library's functionality in the `documentation <https://finra.hawkberry.com/en/latest/>`__.
+
+For detailed instructions on how to get started with ``finra-py``, see `Getting Started <https://finra.hawkberry.com/en/latest/getting-started.html>`__.
+
+++++++++++++++++++++++++++++++
+Why should I use ``finra-py``?
+++++++++++++++++++++++++++++++
+
+``finra-py`` is designed to provide a few important pieces of functionality:
+
+1. **Safe Authentication**: The FINRA API Platform authentication and authorization scheme is based on OAuth 2.0. However, too many people online end up rolling their own implementation of the OAuth 2.0 authentication flow, which is both unnecessarily complex and dangerous. ``finra-py`` handles the token fetch and management for you.
+
+2. **Minimal API Wrapping**: Unlike some other API wrappers, which build in lots of opinionated logic and validation, ``finra-py`` takes raw values and returns raw responses, allowing you to interpret the complex API responses as you see fit. Anything you can do with raw HTTP requests you can do with ``finra-py``, only more easily.
+
+3. **All API Endpoints**: The ``finra-py`` library is designed to provide thorough coverage of the FINRA API Platform. With this goal in mind, ``finra-py`` implements full functionality for every dataset and regulatory filing supported by the FINRA API and described in the documentation.
+
++++++++++++
+Limitations
++++++++++++
+
+``finra-py`` strives to provide comprehensive coverage of all documented datasets for the FINRA API. However, there are some datasets and services available through FINRA that may not be available through the FINRA API. See `FINRA Data <https://www.finra.org/finra-data>`__ for information about all available FINRA datasets.
+
+ - ``finra-py`` does not currently support FINRA's fileX API
+ 
+++++++++++++++++++++
+Help and Development
+++++++++++++++++++++
+
+For troubleshooting guidance and answers to common questions, see the
+`Getting Help <https://finra.hawkberry.com/en/latest/help.html>`__ page.
+
+Submit bug reports on the ``finra-py`` `Issues Page <https://github.com/hawkberry/finra-py/issues>`__ on GitHub.
+
+If you need a dataset or feature that is not currently supported by the client, please file a `Feature Request <https://github.com/hawkberry/finra-py/issues>`__. Pull requests are not currently accepted.
+
+++++++++++++++++++++
+FINRA API Consulting
+++++++++++++++++++++
+
+Need help implementing the FINRA API?
+
+As the author and maintainer of ``finra-py``, I provide consulting on FINRA API integrations, Web EFT migrations, compliance-related workflows, and market data systems.
+
+See the `consulting page <https://finra.hawkberry.com/en/latest/consulting.html>`__ for more information.
+
++++++++++++++
+Project Links
++++++++++++++
+
+* `Documentation <https://finra.hawkberry.com/en/latest/>`__
+* `Repository <https://github.com/hawkberry/finra-py>`__
+* `PyPI <https://pypi.org/project/finra-py/>`__
+* `Changelog <https://github.com/hawkberry/finra-py/blob/main/CHANGELOG.md>`__
+* `Consulting <https://finra.hawkberry.com/en/latest/consulting.html>`__
+* `Support <https://support.hawkberry.com/>`__
+* `Issues <https://github.com/hawkberry/finra-py/issues>`__
+
+**Disclaimer:** ``finra-py`` *is an unofficial, open-source client library for the FINRA API. It is not endorsed by, affiliated with, or sponsored by FINRA or any associated organization. Users are responsible for reviewing and complying with the terms of service and usage requirements of the underlying FINRA API. This software is provided under the terms of the* `LICENSE <https://github.com/hawkberry/finra-py/blob/main/LICENSE>`__ *without warranty of any kind.*
+

finra_py-1.0.0/finra/__init__.py

@@ -0,0 +1,9 @@
+from . import async_client as async_client
+from . import auth as auth
+from . import client as client
+from . import debug as debug
+from . import exceptions as exceptions
+from . import filings as filings
+from . import filters as filters
+from . import log_redactor as log_redactor
+from . import utils as utils