bullishpy 0.4.0__py3-none-any.whl

bullish/analysis/filter.py

@@ -0,0 +1,123 @@
+from functools import cached_property
+from typing import Literal, Set, get_args, Dict, Any, Optional, List
+
+from bearish.types import SeriesLength  # type: ignore
+from pydantic import BaseModel, Field
+
+Industry = Literal[
+    "Food & Staples Retailing",
+    "Packaged Foods",
+    "Grocery Stores",
+    "Household Products",
+    "Household & Personal Products",
+    "Confectioners",
+    "Beverages",
+    "Beverages - Non - Alcoholic",
+    "Beverages - Wineries & Distilleries",
+    "Pharmaceuticals",
+    "Health Care Providers & Services",
+    "Health Care Equipment & Supplies",
+    "Healthcare Plans",
+    "Medical Devices",
+    "Medical Instruments & Supplies",
+    "Medical Care Facilities",
+    "Diagnostics & Research",
+    "Drug Manufacturers - General",
+    "Drug Manufacturers - Specialty & Generic",
+    "Pharmaceutical Retailers",
+    "Health Information Services",
+    "Medical Distribution",
+    "Electric Utilities",
+    "Gas Utilities",
+    "Water Utilities",
+    "Utilities - Diversified",
+    "Utilities - Regulated Electric",
+    "Utilities - Regulated Gas",
+    "Utilities - Renewable",
+    "Utilities - Independent Power Producers",
+    "Waste Management",
+    "Pollution & Treatment Controls",
+    "Security & Protection Services",
+    "Insurance",
+    "Insurance - Property & Casual",
+]
+
+Country = Literal[
+    "Germany",
+    "France",
+    "Netherlands",
+    "Belgium",
+    "Italy",
+    "Spain",
+    "Switzerland",
+    "Sweden",
+    "Denmark",
+    "Norway",
+    "Finland",
+    "Portugal",
+    "Austria",
+    "United states",
+]
+SIGNS = {
+    "price_per_earning_ratio": "<",
+    "market_capitalization": ">",
+    "industry": " IN ",
+    "country": " IN ",
+}
+
+
+class FilterQuery(BaseModel):
+    positive_free_cash_flow: bool = Field(
+        False, description="The username for the database."
+    )
+    positive_net_income: bool = False
+    positive_operating_income: bool = False
+    quarterly_positive_free_cash_flow: bool = False
+    quarterly_positive_net_income: bool = False
+    quarterly_positive_operating_income: bool = False
+    growing_net_income: bool = False
+    quarterly_operating_cash_flow_is_higher_than_net_income: bool = False
+    operating_cash_flow_is_higher_than_net_income: bool = False
+    rsi_last_value_exists: bool = False
+    market_capitalization: int = Field(
+        0, ge=0, multiple_of=1000, description="Positive integer with step count of 10."
+    )
+    price_per_earning_ratio: int = Field(
+        0, ge=0, multiple_of=10, description="Positive integer with step count of 10."
+    )
+    industry: Set[Industry] = Field(None, description="Industry name.")  # type: ignore
+    country: Set[Country] = Field(None, description="Country name.")  # type: ignore
+
+    @cached_property
+    def query_parameters(self) -> Dict[str, Any]:
+        if not bool(self.industry):
+            self.industry = tuple(get_args(Industry))  # type: ignore
+        if not bool(self.country):
+            self.country = tuple(get_args(Country))  # type: ignore
+        return self.model_dump(exclude_defaults=True, exclude_unset=True)
+
+    def to_query(self) -> str:
+        query = " AND ".join(
+            [f"{k}{SIGNS.get(k,'=')}{v}" for k, v in self.query_parameters.items()]
+        )
+        return query
+
+
+class FilterQueryStored(FilterQuery):
+    industry: Optional[List[Industry]] = None  # type: ignore
+    country: Optional[List[Country]] = None  # type: ignore
+
+
+class FilterUpdate(BaseModel):
+    window_size: SeriesLength = Field("5d")
+    data_age_in_days: int = 1
+    update_financials: bool = False
+    update_analysis_only: bool = False
+
+
+class FilteredResults(BaseModel):
+    name: str
+    filter_query: FilterQueryStored
+    symbols: list[str] = Field(
+        default_factory=list, description="List of filtered tickers."
+    )

bullish/app/app.py

@@ -0,0 +1,218 @@
+import shelve
+import uuid
+from pathlib import Path
+from typing import Optional
+
+import pandas as pd
+import streamlit as st
+import streamlit_pydantic as sp
+from bearish.models.base import Ticker  # type: ignore
+from bearish.models.price.prices import Prices  # type: ignore
+from bearish.models.query.query import AssetQuery, Symbols  # type: ignore
+from streamlit_file_browser import st_file_browser  # type: ignore
+
+from bullish.database.crud import BullishDb
+from bullish.figures.figures import plot
+from bullish.analysis.filter import (
+    FilterQuery,
+    FilterUpdate,
+    FilteredResults,
+    FilterQueryStored,
+)
+from bullish.jobs.models import JobTracker
+from bullish.jobs.tasks import update, news
+
+CACHE_SHELVE = "user_cache"
+DB_KEY = "db_path"
+
+st.set_page_config(layout="wide")
+
+
+@st.cache_resource
+def db_id() -> str:
+    return f"{DB_KEY}_{uuid.uuid4()!s}"
+
+
+@st.cache_resource
+def bearish_db(database_path: Path) -> BullishDb:
+    return BullishDb(database_path=database_path)
+
+
+def store_db(db_path: Path) -> None:
+    with shelve.open(CACHE_SHELVE) as storage:  # noqa:S301
+        storage[db_id()] = str(db_path)
+
+
+def load_db() -> Optional[str]:
+    with shelve.open(CACHE_SHELVE) as db:  # noqa:S301
+        db_path = db.get(db_id())
+        return db_path
+
+
+def assign_db_state() -> None:
+    if "database_path" not in st.session_state:
+        st.session_state.database_path = load_db()
+
+
+@st.cache_data(hash_funcs={BullishDb: lambda obj: hash(obj.database_path)})
+def load_analysis_data(bullish_db: BullishDb) -> pd.DataFrame:
+    return bullish_db.read_analysis_data()
+
+
+def on_table_select() -> None:
+
+    row = st.session_state.selected_data["selection"]["rows"]
+
+    db = bearish_db(st.session_state.database_path)
+    if st.session_state.data.empty or (
+        not st.session_state.data.iloc[row]["symbol"].to_numpy()
+    ):
+        return
+
+    symbol = st.session_state.data.iloc[row]["symbol"].to_numpy()[0]
+    query = AssetQuery(symbols=Symbols(equities=[Ticker(symbol=symbol)]))
+    prices = db.read_series(query, months=24)
+    data = Prices(prices=prices).to_dataframe()
+
+    fig = plot(data, symbol)
+
+    st.session_state.ticker_figure = fig
+
+
+@st.dialog("🔑  Provide database file to continue")
+def dialog_pick_database() -> None:
+    current_working_directory = Path.cwd()
+    event = st_file_browser(
+        path=current_working_directory, key="A", glob_patterns="**/*.db"
+    )
+    if event:
+        db_path = Path(current_working_directory).joinpath(event["target"]["path"])
+        if not (db_path.exists() and db_path.is_file()):
+            st.error("Please choose a valid file.")
+            st.stop()
+        st.session_state.database_path = db_path
+        store_db(db_path)
+        st.rerun()
+    if event is None:
+        st.stop()
+
+
+@st.dialog("📈  Price history and analysis", width="large")
+def dialog_plot_figure() -> None:
+    st.markdown(
+        """
+    <style>
+    div[data-testid="stDialog"] div[role="dialog"]:has(.big-dialog) {
+        width: 90vw;
+        height: 110vh;
+    }
+    </style>
+    """,
+        unsafe_allow_html=True,
+    )
+    st.html("<span class='big-dialog'></span>")
+    st.plotly_chart(st.session_state.ticker_figure, use_container_width=True)
+    st.session_state.ticker_figure = None
+
+
+def main() -> None:  # noqa: PLR0915, C901
+    assign_db_state()
+    if st.session_state.database_path is None:
+        dialog_pick_database()
+    bearish_db_ = bearish_db(st.session_state.database_path)
+    charts_tab, jobs_tab = st.tabs(["Charts", "Jobs"])
+    if "data" not in st.session_state:
+        st.session_state.data = load_analysis_data(bearish_db_)
+    with st.sidebar:
+        with st.expander("Filter"):
+            view_query = sp.pydantic_form(key="my_form", model=FilterQuery)
+            if view_query:
+                st.session_state.data = bearish_db_.read_filter_query(view_query)
+                st.session_state.ticker_figure = None
+                st.session_state.filter_query = view_query
+            with st.container(border=True):
+                disabled = "filter_query" not in st.session_state
+                if "filter_query" in st.session_state:
+                    disabled = st.session_state.filter_query is None
+                user_input = st.text_input("Enter your name:", disabled=disabled)
+                headless = st.checkbox("Headless mode", value=True, disabled=disabled)
+                if st.button("Save", disabled=disabled):
+                    name = user_input.strip()
+                    if not name:
+                        st.error("This field is required.")
+                    else:
+                        symbols = st.session_state.data["symbol"].unique().tolist()
+                        filtered_results = FilteredResults(
+                            name=name,
+                            filter_query=FilterQueryStored.model_validate(
+                                st.session_state.filter_query.model_dump()
+                            ),
+                            symbols=symbols,
+                        )
+
+                        bearish_db_.write_filtered_results(filtered_results)
+                        res = news(
+                            database_path=st.session_state.database_path,
+                            symbols=symbols,
+                            headless=headless,
+                        )
+                        bearish_db_.write_job_tracker(
+                            JobTracker(job_id=str(res.id), type="Fetching news")
+                        )
+                        st.session_state.filter_query = None
+                        st.success(f"Hello, {user_input}!")
+        with st.expander("Load"):
+            existing_filtered_results = bearish_db_.read_list_filtered_results()
+            option = st.selectbox("Saved results", ["", *existing_filtered_results])
+            if option:
+                filtered_results_ = bearish_db_.read_filtered_results(option)
+                if filtered_results_:
+                    st.session_state.data = bearish_db_.read_analysis_data(
+                        symbols=filtered_results_.symbols
+                    )
+
+        with st.expander("Update"):
+            update_query = sp.pydantic_form(key="update", model=FilterUpdate)
+            if (
+                update_query
+                and st.session_state.data is not None
+                and not st.session_state.data.empty
+            ):
+                symbols = st.session_state.data["symbol"].unique().tolist()
+                res = update(
+                    database_path=st.session_state.database_path,
+                    symbols=symbols,
+                    update_query=update_query,
+                )  # enqueue & get result-handle
+                bearish_db_.write_job_tracker(
+                    JobTracker(job_id=str(res.id), type="Update data")
+                )
+                st.success("Data update job has been enqueued.")
+                st.rerun()
+    with charts_tab:
+        st.header("✅ Data overview")
+        st.dataframe(
+            st.session_state.data,
+            on_select=on_table_select,
+            selection_mode="single-row",
+            key="selected_data",
+            use_container_width=True,
+            height=600,
+        )
+        if (
+            "ticker_figure" in st.session_state
+            and st.session_state.ticker_figure is not None
+        ):
+            dialog_plot_figure()
+
+    with jobs_tab:
+        job_trackers = bearish_db_.read_job_trackers()
+        st.dataframe(
+            job_trackers,
+            use_container_width=True,
+            hide_index=True,
+        )
+
+
+if __name__ == "__main__":
+    main()

bullish/cli.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+import subprocess
+import signal
+import sys
+import time
+import atexit
+from pathlib import Path
+from typing import Any
+
+import typer
+
+app = typer.Typer(add_completion=False)
+STREAMLIT_FILE = Path(__file__).parent.joinpath("app", "app.py")
+
+
+@app.command()
+def serve(
+    host: str = typer.Option("0.0.0.0", help="Streamlit host"),  # noqa: S104
+    port: int = typer.Option(8501, help="Streamlit port"),
+) -> None:
+    children: list[subprocess.Popen] = []  # type: ignore
+
+    def _shutdown(*_: Any) -> None:
+        for p in children:
+            if p.poll() is None:
+                p.send_signal(signal.SIGINT)
+                try:
+                    p.wait(timeout=5)
+                except subprocess.TimeoutExpired:
+                    p.kill()
+        sys.exit(0)
+
+    signal.signal(signal.SIGINT, _shutdown)
+    signal.signal(signal.SIGTERM, _shutdown)
+    atexit.register(_shutdown)
+
+    try:
+        children.append(
+            subprocess.Popen(
+                [  # noqa: S603
+                    sys.executable,
+                    "-m",
+                    "huey.bin.huey_consumer",
+                    "bullish.jobs.tasks.huey",
+                ]
+            )
+        )
+        children.append(
+            subprocess.Popen(
+                [  # noqa: S603
+                    sys.executable,
+                    "-m",
+                    "streamlit",
+                    "run",
+                    str(STREAMLIT_FILE),
+                    "--server.address",
+                    host,
+                    "--server.port",
+                    str(port),
+                ]
+            )
+        )
+        while True:
+            time.sleep(1)
+
+    except Exception as exc:  # pragma: no cover
+        typer.secho(f"❌ Failed to start services: {exc}", fg=typer.colors.RED, err=True)
+        _shutdown()
+
+
+if __name__ == "__main__":
+    app()

bullish/database/alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.

bullish/database/alembic/alembic.ini

@@ -0,0 +1,117 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = .
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to ./versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:./versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+# version_path_separator = newline
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

bullish/database/alembic/env.py

@@ -0,0 +1,80 @@
+import os
+
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+from sqlmodel import SQLModel
+
+from bullish.database.schemas import *  # noqa: F403
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+# if config.config_file_name is not None:
+#     fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = SQLModel.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    context.configure(
+        url=os.getenv("DATABASE_URL"),
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    configuration = config.get_section(config.config_ini_section, {})
+    configuration["sqlalchemy.url"] = os.getenv("DATABASE_URL")  # type: ignore
+    connectable = engine_from_config(
+        configuration,
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection, target_metadata=target_metadata, render_as_batch=True
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

bullish/database/alembic/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}