valuein-sdk 7.2.0__tar.gz → 7.3.0__tar.gz

{valuein_sdk-7.2.0 → valuein_sdk-7.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: valuein-sdk
-Version: 7.2.0
+Version: 7.3.0
 Summary: Point-in-time, survivorship-free SEC EDGAR fundamentals in Python: DuckDB SQL over Parquet, traceable fact_ids, factor backtests.
 Project-URL: Homepage, https://valuein.biz
 Project-URL: Documentation, https://valuein.biz/developers/python-sdk
@@ -543,6 +543,7 @@ snapshot and schema version you are reading. "PIT" means the view is filtered to
 | `stock_price` | Close and `total_return_index` at period ends and completed month ends | Yes | All |
 | `stock_price_daily` | Daily OHLCV bars, `div_cash`, `split_factor`, `total_return_index`, `is_primary_listing` | Yes | Pro, Institutional |
 | `restatement_events` | Values a later filing changed, with both accessions and a `disclosure_class` | | All |
+| `industry_classification` | Point-in-time SIC spells keyed on `cik`: `sic_code`, `sic_industry_group`, `sic_major_group`, `sic_division`, `sector`, `industry`, `valid_from`, `valid_to` (exclusive, NULL = current). `references.sector` is current only | | All |
 | Smart money | `insider_party`, `insider_filing`, `insider_transaction`, `insider_ownership`, `insider_footnote`, `insider_ownership_purpose`, `institutional_filing`, `institutional_holding`, `institutional_other_manager` | Yes, except `insider_party` | Institutional |
 | Form ADV | `investment_adviser`, `investment_adviser_private_fund` (keyed on CRD, not CIK) | | Institutional |
 

{valuein_sdk-7.2.0 → valuein_sdk-7.3.0}/README.md

@@ -483,6 +483,7 @@ snapshot and schema version you are reading. "PIT" means the view is filtered to
 | `stock_price` | Close and `total_return_index` at period ends and completed month ends | Yes | All |
 | `stock_price_daily` | Daily OHLCV bars, `div_cash`, `split_factor`, `total_return_index`, `is_primary_listing` | Yes | Pro, Institutional |
 | `restatement_events` | Values a later filing changed, with both accessions and a `disclosure_class` | | All |
+| `industry_classification` | Point-in-time SIC spells keyed on `cik`: `sic_code`, `sic_industry_group`, `sic_major_group`, `sic_division`, `sector`, `industry`, `valid_from`, `valid_to` (exclusive, NULL = current). `references.sector` is current only | | All |
 | Smart money | `insider_party`, `insider_filing`, `insider_transaction`, `insider_ownership`, `insider_footnote`, `insider_ownership_purpose`, `institutional_filing`, `institutional_holding`, `institutional_other_manager` | Yes, except `insider_party` | Institutional |
 | Form ADV | `investment_adviser`, `investment_adviser_private_fund` (keyed on CRD, not CIK) | | Institutional |
 

{valuein_sdk-7.2.0 → valuein_sdk-7.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name            = "valuein-sdk"
-version = "7.2.0"
+version = "7.3.0"
 description     = "Point-in-time, survivorship-free SEC EDGAR fundamentals in Python: DuckDB SQL over Parquet, traceable fact_ids, factor backtests."
 readme          = "README.md"
 requires-python = ">=3.10"

{valuein_sdk-7.2.0 → valuein_sdk-7.3.0}/valuein_sdk/__init__.py

@@ -62,7 +62,8 @@ listed in ``valuein_sdk.catalog.PIT_TABLES`` (``filing``, ``fact``,
 template and typed method; ``ratio`` also keeps only the latest vintage per
 key. Not filtered by ``as_of``: ``references``, ``entity``, ``security``,
 ``filing_registrant`` (join it to ``filing`` for the filter),
-``index_membership``, ``restatement_events``, the Form ADV tables and the
+``index_membership``, ``restatement_events``, ``industry_classification`` (its
+own ``valid_from`` / ``valid_to`` spells), the Form ADV tables and the
 reference/taxonomy tables, and ``client.get(table)``, which downloads a
 table raw.
 """

{valuein_sdk-7.2.0 → valuein_sdk-7.3.0}/valuein_sdk/catalog/tables.py

@@ -98,6 +98,11 @@ KNOWN_TABLES = frozenset(
         # domain/restatements.py and the naming-discipline test, which
         # enforces this at build time).
         "restatement_events",
+        # Point-in-time SIC classification SPELLS per CIK (schema 4.5.0+),
+        # every tier. Not PIT-classified: no accepted_at; the spell's own
+        # valid_from / valid_to (exclusive, NULL = current) answer as-of
+        # questions. No GICS (licensed).
+        "industry_classification",
         # ── Core: market data (EOD prices, every tier) ───────────────────
         # Coarse pre-aggregation of stock_price_daily, on every tier: one row
         # per entity at each period_end + monthly closes (`observation`

{valuein_sdk-7.2.0 → valuein_sdk-7.3.0}/valuein_sdk/queries/SQL_CHEATSHEET.md

@@ -34,6 +34,7 @@ from the manifest: `client.get_schema("fact")`.
 | `standard_concept` | curated concept | The dictionary for `fact.standard_concept`: `definition`, `statement_type`, `unit_default`, `is_flow`, `review_confidence`. | no | all |
 | `taxonomy_guide` | raw XBRL tag | Labels and definitions for raw tags. Its `standard_concept` column holds the tag name without prefix (`Revenues`); join it on `split_part(fact.concept, ':', 2)`. | no | all |
 | `restatement_events` | restated fact | Before/after pairs with `delta_pct`, `severity`, both accessions and `disclosure_class` (`non_reliance`, `amended`, `undisclosed`). | no (public diff feed) | all |
+| `industry_classification` | (company, SIC spell) | `sic_code` (4-digit), `sic_industry_group` (3), `sic_major_group` (2), `sic_division`, `sic_division_name`, `sector`, `industry`, `valid_from`, `valid_to` (exclusive, NULL = current), `first_accession_id`, `last_accession_id`, `evidence_count`, `valid_from_basis`. No GICS. | no (spell dates are in the rows) | all |
 | `stock_price` | (company, observation) | Coarse closes: `observation = 'period_end'` (at fiscal period ends) or `'monthly'`; raw `close`, `total_return_index`, primary listing only. | yes | all |
 | `stock_price_daily` | (security, trading day) | Daily OHLCV, `total_return_index`, `is_primary_listing`, `adjusted_close` (recent bars only). | yes | Pro, Institutional |
 | `insider_party`, `insider_filing`, `insider_transaction`, `institutional_filing`, `institutional_holding`, `insider_ownership` | see `client.get_schema()` | Smart money: Forms 3/4/5/144, 13F-HR, SC 13D/13G. | yes (except `insider_party`) | Institutional |
@@ -257,6 +258,23 @@ LIMIT  20;
 filings), `amended` (corrected in a 10-K/A or 10-Q/A) or `undisclosed` (the value
 changed inside a routine periodic filing).
 
+### Industry on a date (spells, not current values)
+
+`references.sector`, `references.industry` and `references.sic_code` are CURRENT
+values. For history use `industry_classification` and keep the spell in force at
+the date: `valid_from <= t AND (valid_to IS NULL OR t < valid_to)`. There are no
+rows before a company's first evidence.
+
+```sql
+-- Max one position per sub-industry (4-digit SIC) on 2020-06-30
+SELECT ic.sic_code, ANY_VALUE(ic.industry) AS industry, COUNT(*) AS companies
+FROM   industry_classification ic
+WHERE  ic.valid_from <= TIMESTAMPTZ '2020-06-30 00:00:00+00'
+  AND  (ic.valid_to IS NULL OR TIMESTAMPTZ '2020-06-30 00:00:00+00' < ic.valid_to)
+GROUP  BY ic.sic_code
+ORDER  BY companies DESC;
+```
+
 ---
 
 ## Pattern 8 — Human-readable concept labels
@@ -521,7 +539,9 @@ published: compute one locally with your own assumptions via `client.dcf()`
 ### `rank` — sector percentiles
 
 `{ratio}_sector_pctile`, unit `percentile`, a value from 0 to 1 placing the
-company within its sector. FY and TTM for `roic`, `roce`, `return_on_equity`,
+company within its sector, the sector in force at the underlying filing's
+acceptance time (`industry_classification`), not today's. The percentile rows
+themselves still carry `accepted_at` NULL. FY and TTM for `roic`, `roce`, `return_on_equity`,
 `return_on_assets`, `net_margin`, `operating_margin`, `gross_profit_margin`,
 `ebitda_margin`, `fcf_margin`, `ocf_margin`, `fcf_conversion`, `debt_to_equity`,
 `net_debt_to_ebitda`, `current_ratio`, `interest_coverage`, `asset_turnover`,