finbrain-python 0.1.1__tar.gz

finbrain_python-0.1.1/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

finbrain_python-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ['3.9', '3.10', '3.11', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+            python-version: ${{ matrix.python }}
+      - run: pip install -e .[dev]
+      - run: ruff check .
+      - run: pytest -q

finbrain_python-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Build & Publish
+
+on:
+  push:
+    tags: ['[0-9]*']          # e.g. v0.1.0, v1.2.3
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with: {python-version: '3.12'}
+
+      - name: Install build backend
+        run: python -m pip install --upgrade build twine setuptools setuptools_scm[toml]
+
+      - name: Build wheel + sdist
+        run: python -m build
+
+      # ─────────── push to TestPyPI first ───────────
+      - name: Upload to TestPyPI
+        run: twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+
+      # ─────────── then to production PyPI ───────────
+      - name: Upload to PyPI
+        run: twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}

finbrain_python-0.1.1/.gitignore

@@ -0,0 +1,181 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor  
+#  Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to 
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore

finbrain_python-0.1.1/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/PKG-INFO

@@ -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.