finbrain-python 0.1.1__py3-none-any.whl

finbrain_python-0.1.1.dist-info/METADATA

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: finbrain-python
+Version: 0.1.1
+Summary: Official Python client for the FinBrain API
+Author-email: Ahmet Salim Bilgin <ahmet@finbrain.tech>
+License-Expression: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31
+Requires-Dist: typer[all]>=0.12
+Requires-Dist: pandas>=2.2
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: responses; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# FinBrain Python SDK&nbsp;<!-- omit in toc -->
+
+[![PyPI version](https://img.shields.io/pypi/v/finbrain-python.svg)](https://pypi.org/project/finbrain-python/)
+[![CI](https://github.com/finbrain-tech/finbrain-python/actions/workflows/ci.yml/badge.svg)](https://github.com/finbrain-tech/finbrain-python/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
+
+**Official Python client** for the [FinBrain API](https://docs.finbrain.tech).  
+Fetch deep-learning price predictions, sentiment scores, insider trades, LinkedIn metrics, options data and more — with a single import.
+
+*Python ≥ 3.9  •  requests & pandas  •  asyncio optional.*
+
+---
+
+## ✨ Features
+- One-line auth (`FinBrainClient(api_key="…")`)
+- Complete endpoint coverage (predictions, sentiments, options, insider, etc.)
+- Transparent retries & custom error hierarchy (`FinBrainError`)
+- Async parity with `finbrain.aio` (`httpx`)
+- CLI (`finbrain markets`, `finbrain predict AAPL`)
+- Auto-version from Git tags (setuptools-scm)
+- MIT-licensed, fully unit-tested
+
+---
+
+## 🚀 Quick start
+Install the SDK:
+```
+pip install finbrain-python
+```
+Create a client and fetch data:
+```
+from finbrain import FinBrainClient
+
+fb = FinBrainClient(api_key="YOUR_KEY")        # create once, reuse below
+
+# ---------- availability ----------
+fb.available.markets()                         # list markets
+fb.available.tickers("daily", as_dataframe=True)
+
+# ---------- app ratings ----------
+fb.app_ratings.ticker("S&P 500", "AMZN",
+                      date_from="2025-01-01",
+                      date_to="2025-05-31",
+                      as_dataframe=True)
+
+# ---------- analyst ratings ----------
+fb.analyst_ratings.ticker("S&P 500", "AMZN",
+                          date_from="2025-01-01",
+                          date_to="2025-05-31",
+                          as_dataframe=True)
+
+# ---------- house trades ----------
+fb.house_trades.ticker("S&P 500", "AMZN",
+                       date_from="2025-01-01",
+                       date_to="2025-05-31",
+                       as_dataframe=True)
+
+# ---------- insider transactions ----------
+fb.insider_transactions.ticker("S&P 500", "AMZN", as_dataframe=True)
+
+# ---------- LinkedIn metrics ----------
+fb.linkedin_data.ticker("S&P 500", "AMZN",
+                        date_from="2025-01-01",
+                        date_to="2025-05-31",
+                        as_dataframe=True)
+
+# ---------- options put/call ----------
+fb.options.put_call("S&P 500", "AMZN",
+                    date_from="2025-01-01",
+                    date_to="2025-05-31",
+                    as_dataframe=True)
+
+# ---------- price predictions ----------
+fb.predictions.market("S&P 500", as_dataframe=True)   # all tickers in market
+fb.predictions.ticker("AMZN", as_dataframe=True)      # single ticker
+
+# ---------- news sentiment ----------
+fb.sentiments.ticker("S&P 500", "AMZN",
+                     date_from="2025-01-01",
+                     date_to="2025-05-31",
+                     as_dataframe=True)
+```
+
+## 🔑 Authentication
+
+To call the API you need an **API key**, obtained by purchasing a **FinBrain API subscription**.  
+*(The Terminal-only subscription does **not** include an API key.)*
+
+1. Subscribe at <https://www.finbrain.tech> → FinBrain API.
+2. Copy the key from your dashboard.
+3. Pass it once when you create the client:
+
+```
+from finbrain import FinBrainClient
+fb = FinBrainClient(api_key="YOUR_KEY")
+```
+
+### Async(currently under development)
+
+```
+import asyncio, os
+from finbrain.aio import FinBrainAsyncClient async
+def  main():
+	async  with FinBrainAsyncClient(api_key=os.getenv("FINBRAIN_API_KEY")) as fb:
+        data = await fb.sentiments.ticker("sp500", "AMZN")
+        print(list(data["sentimentAnalysis"].items())[:3])
+
+asyncio.run(main())` 
+```
+
+### CLI(currently under development)
+
+```
+export FINBRAIN_API_KEY=your_key
+finbrain markets
+finbrain predict AAPL --type daily
+``` 
+
+----------
+
+## 📚 Supported endpoints
+
+| Category             | Method                                   | Path                                                 |
+|----------------------|------------------------------------------|------------------------------------------------------|
+| Availability         | `client.available.markets()`             | `/available/markets`                                 |
+|                      | `client.available.tickers()`             | `/available/tickers/{TYPE}`                          |
+| Predictions          | `client.predictions.ticker()`            | `/ticker/{TICKER}/predictions/{daily\|monthly}`      |
+|                      | `client.predictions.market()`            | `/market/{MARKET}/predictions/{daily\|monthly}`      |
+| Sentiments           | `client.sentiments.ticker()`             | `/sentiments/{MARKET}/{TICKER}`                      |
+| App ratings          | `client.app_ratings.ticker()`            | `/appratings/{MARKET}/{TICKER}`                      |
+| Analyst ratings      | `client.analyst_ratings.ticker()`        | `/analystratings/{MARKET}/{TICKER}`                  |
+| House trades         | `client.house_trades.ticker()`           | `/housetrades/{MARKET}/{TICKER}`                     |
+| Insider transactions | `client.insider_transactions.ticker()`   | `/insidertransactions/{MARKET}/{TICKER}`             |
+| LinkedIn             | `client.linkedin_data.ticker()`          | `/linkedindata/{MARKET}/{TICKER}`                    |
+| Options – Put/Call   | `client.options.put_call()`              | `/putcalldata/{MARKET}/{TICKER}`                     |
+
+----------
+
+## 🛠️ Error-handling
+
+```
+from finbrain.exceptions import BadRequest
+try:
+    fb.predictions.ticker("MSFT", prediction_type="weekly")
+except BadRequest as exc:
+	print("Invalid parameters:", exc)` 
+```
+
+| HTTP status | Exception class          | Meaning                               |
+|-------------|--------------------------|---------------------------------------|
+| 400         | `BadRequest`             | The request is invalid or malformed   |
+| 401         | `AuthenticationError`    | API key missing or incorrect          |
+| 403         | `PermissionDenied`       | Authenticated, but not authorised     |
+| 404         | `NotFound`               | Resource or endpoint not found        |
+| 405         | `MethodNotAllowed`       | HTTP method not supported on endpoint |
+| 500         | `ServerError`            | FinBrain internal error               |
+
+----------
+
+## 🔄 Versioning & release
+
+-   Semantic Versioning (`MAJOR.MINOR.PATCH`)
+    
+-   Version auto-generated from Git tags (setuptools-scm)
+
+```
+git tag -a v0.2.0 -m "Add options.chain endpoint"
+git push --tags # GitHub Actions builds & uploads to PyPI
+```
+
+----------
+
+## 🧑‍💻 Development
+
+```
+git clone https://github.com/finbrain-tech/finbrain-python cd finbrain-python
+python -m venv .venv && source .venv/bin/activate
+pip install -e .[dev]
+
+ruff check . # lint / format pytest -q # unit tests (mocked) 
+```
+
+### Live integration test(currently under development)
+
+Set `FINBRAIN_LIVE_KEY`, then run:
+
+```
+pytest -m integration
+```
+----------
+
+## 🤝 Contributing
+
+1.  Fork → create a feature branch
+    
+2.  Add tests & run `ruff --fix`
+    
+3.  Ensure `pytest` & CI pass
+    
+4.  Open a PR — thanks!
+    
+
+----------
+
+## 🔒 Security
+
+Please report vulnerabilities to **info@finbrain.tech**.  
+We respond within 48 hours.
+
+----------
+
+## 📜 License
+
+MIT — see [LICENSE](LICENSE).
+
+----------
+
+© 2025 FinBrain Technologies — Built with ❤️ for the quant community.

finbrain_python-0.1.1.dist-info/RECORD

@@ -0,0 +1,20 @@
+finbrain/__init__.py,sha256=PUa6ru37E44rB-ot32_u5iqKXaHe-Y-mUZpLLOwnYIk,333
+finbrain/client.py,sha256=Y7SfXhhzXSDggY-SWTtiyt6zj-1HyD4sLEa6AS-zSug,4061
+finbrain/exceptions.py,sha256=_STlzmP7Z1qDkFic3QU4QqyY07MMhMm46Tmgy7HHuck,5258
+finbrain/aio/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+finbrain/aio/client.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+finbrain/endpoints/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+finbrain/endpoints/analyst_ratings.py,sha256=iU9JriTj-DzlgN3PH6imxM1q31ff4DCIZdzQRh286Lo,2953
+finbrain/endpoints/app_ratings.py,sha256=_AnoHoN7UnLWnMeEnIpFyhIr7zAWt28dNcFwN2W2r9c,3214
+finbrain/endpoints/available.py,sha256=JYNgRh3BoWNApLRoYM2dkOks5UmwrsCSE6gfkmtm-t4,2739
+finbrain/endpoints/house_trades.py,sha256=FL4jBISN7WGIZubNsBp2LNiEgVLlE9EUZ9GIZFSpbw8,2814
+finbrain/endpoints/insider_transactions.py,sha256=lV3Zaz2SfuEnJvThAyxtfh-WuGjLN09WXc3oN0EcH6g,2336
+finbrain/endpoints/linkedin_data.py,sha256=WfuBBGQ2yR-414R26CzfJJImlTS7k0uWN_w0wziGBa8,2973
+finbrain/endpoints/options.py,sha256=dzVVvXoHbWfBo39afUg_IQ35qHTPfROf-ssKg929uLg,3446
+finbrain/endpoints/predictions.py,sha256=kDxC1ubKbpapeF12qahiGrD6V68ljBXuWdiu_0jHq64,4166
+finbrain/endpoints/sentiments.py,sha256=jqYSPM-_-Vge1MkU-pQ0oyJQgI_nVYf-Ocq8qiLPAlA,3569
+finbrain_python-0.1.1.dist-info/licenses/LICENSE,sha256=x71LjIUPbK7Y8YBulH_AXzEIX7BK90dgFL2zA6LBT-A,1069
+finbrain_python-0.1.1.dist-info/METADATA,sha256=JGCu1Nu4khVj_W826cObCqZb-EghvetalZeVilr15NY,8192
+finbrain_python-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+finbrain_python-0.1.1.dist-info/top_level.txt,sha256=dCiQtTx3z2TtO_yQI6q3yODcdb-pABB-iEReJegVAv0,9
+finbrain_python-0.1.1.dist-info/RECORD,,

finbrain_python-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

finbrain_python-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ahmetsbilgin
+
+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.

finbrain_python-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+finbrain