finstmt package

Work with financial statement data in Python. Can calculate free cash flows and help project financial statements, automatically balancing the balance sheet.

Subpackages

• finstmt.bs package
  • Submodules
  • finstmt.bs.config module
  • finstmt.bs.main module
    • BalanceSheets
      • BalanceSheets.__init__()
      • BalanceSheets.items_config_list
      • BalanceSheets.statement_name
      • BalanceSheets.statements
• finstmt.clean package
  • Submodules
  • finstmt.clean.name module
    • standardize_name_for_look_up()
    • standardize_names_in_series_index()
• finstmt.combined package
  • Submodules
  • finstmt.combined.combinator module
    • FinancialStatementsCombinator
      • FinancialStatementsCombinator.add()
      • FinancialStatementsCombinator.divide()
      • FinancialStatementsCombinator.multiply()
      • FinancialStatementsCombinator.subtract()
    • ForecastedFinancialStatementsCombinator
      • ForecastedFinancialStatementsCombinator.add()
      • ForecastedFinancialStatementsCombinator.divide()
      • ForecastedFinancialStatementsCombinator.multiply()
      • ForecastedFinancialStatementsCombinator.subtract()
    • StatementsCombinator
      • StatementsCombinator.__init__()
      • StatementsCombinator.add()
      • StatementsCombinator.divide()
      • StatementsCombinator.multiply()
      • StatementsCombinator.subtract()
  • finstmt.combined.statements module
    • FinancialStatements
      • FinancialStatements.__init__()
      • FinancialStatements.all_config_items
      • FinancialStatements.auto_adjust_config
      • FinancialStatements.balance_sheets
      • FinancialStatements.calculate
      • FinancialStatements.capex
      • FinancialStatements.change()
      • FinancialStatements.copy()
      • FinancialStatements.dates
      • FinancialStatements.fcf
      • FinancialStatements.forecast()
      • FinancialStatements.forecast_assumptions
      • FinancialStatements.income_statements
      • FinancialStatements.item_is_empty()
      • FinancialStatements.lag()
      • FinancialStatements.non_cash_expenses
• finstmt.config_manage package
  • Submodules
  • finstmt.config_manage.base module
    • ConfigManagerBase
      • ConfigManagerBase.balance_groups
      • ConfigManagerBase.eq_subs_dict()
      • ConfigManagerBase.eqs_involving()
      • ConfigManagerBase.expr_for()
      • ConfigManagerBase.get()
      • ConfigManagerBase.get_value()
      • ConfigManagerBase.item_determinant_keys()
      • ConfigManagerBase.items
      • ConfigManagerBase.set()
      • ConfigManagerBase.set_value()
      • ConfigManagerBase.sympy_namespace
  • finstmt.config_manage.data module
    • DataConfigManager
      • DataConfigManager.__init__()
      • DataConfigManager.config_dict
      • DataConfigManager.configs
      • DataConfigManager.get()
      • DataConfigManager.items
      • DataConfigManager.keys
      • DataConfigManager.set()
      • DataConfigManager.sympy_namespace
  • finstmt.config_manage.global_ module
  • finstmt.config_manage.statement module
    • StatementConfigManager
      • StatementConfigManager.__init__()
      • StatementConfigManager.config_managers
      • StatementConfigManager.get()
      • StatementConfigManager.items
      • StatementConfigManager.keys
      • StatementConfigManager.set()
      • StatementConfigManager.sympy_namespace
  • finstmt.config_manage.statements module
    • StatementsConfigManager
      • StatementsConfigManager.__init__()
      • StatementsConfigManager.config_managers
      • StatementsConfigManager.dict()
      • StatementsConfigManager.get()
      • StatementsConfigManager.items
      • StatementsConfigManager.json()
      • StatementsConfigManager.keys
      • StatementsConfigManager.set()
      • StatementsConfigManager.sympy_namespace
      • StatementsConfigManager.update()
      • StatementsConfigManager.update_all()
• finstmt.findata package
  • Submodules
  • finstmt.findata.period_data module
    • PeriodFinancialData
      • PeriodFinancialData.__init__()
      • PeriodFinancialData.config_manager
      • PeriodFinancialData.from_series()
      • PeriodFinancialData.maximum_display_verbosity
      • PeriodFinancialData.prior_statement
      • PeriodFinancialData.statement_items
      • PeriodFinancialData.to_series()
      • PeriodFinancialData.unextracted_names
  • finstmt.findata.statement_item module
    • StatementItem
      • StatementItem.__init__()
      • StatementItem.get_value()
      • StatementItem.item_config
      • StatementItem.value
  • finstmt.findata.statementsbase module
    • FinStatementsBase
      • FinStatementsBase.__init__()
      • FinStatementsBase.dates
      • FinStatementsBase.freq
      • FinStatementsBase.from_df()
      • FinStatementsBase.item_is_empty()
      • FinStatementsBase.items_config_list
      • FinStatementsBase.statement_name
      • FinStatementsBase.statements
      • FinStatementsBase.to_df()
    • combine_statement_dfs()
• finstmt.forecast package
  • Subpackages
    • finstmt.forecast.models package
      • Submodules
      • finstmt.forecast.models.average module
        • AverageModel
          • AverageModel.fit()
          • AverageModel.mean
          • AverageModel.predict()
          • AverageModel.stderr
      • finstmt.forecast.models.base module
        • ForecastModel
          • ForecastModel.__init__()
          • ForecastModel.desired_freq_t_multiplier
          • ForecastModel.fit()
          • ForecastModel.historical_freq
          • ForecastModel.last_historical_period
          • ForecastModel.orig_series
          • ForecastModel.plot()
          • ForecastModel.predict()
          • ForecastModel.result
          • ForecastModel.result_df
        • compare_freq_strs()
      • finstmt.forecast.models.cagr module
        • CAGRModel
          • CAGRModel.cagr
          • CAGRModel.fit()
          • CAGRModel.last_value
          • CAGRModel.predict()
          • CAGRModel.stderr
      • finstmt.forecast.models.chooser module
        • get_model()
      • finstmt.forecast.models.manual module
        • ManualForecastModel
          • ManualForecastModel.__init__()
          • ManualForecastModel.fit()
          • ManualForecastModel.predict()
          • ManualForecastModel.recent
      • finstmt.forecast.models.prophet module
        • FBProphetModel
          • FBProphetModel.__init__()
          • FBProphetModel.fit()
          • FBProphetModel.plot()
          • FBProphetModel.predict()
      • finstmt.forecast.models.recent module
        • RecentValueModel
          • RecentValueModel.fit()
          • RecentValueModel.predict()
          • RecentValueModel.recent
      • finstmt.forecast.models.trend module
        • LinearTrendModel
          • LinearTrendModel.fit()
          • LinearTrendModel.model
          • LinearTrendModel.model_result
          • LinearTrendModel.predict()
  • Submodules
  • finstmt.forecast.config module
    • ForecastConfig
      • ForecastConfig.__init__()
      • ForecastConfig.balance
      • ForecastConfig.bs_diff_max
      • ForecastConfig.freq
      • ForecastConfig.make_future_df_kwargs
      • ForecastConfig.periods
      • ForecastConfig.prophet_kwargs
      • ForecastConfig.timeout
    • ForecastItemConfig
      • ForecastItemConfig.__init__()
      • ForecastItemConfig.balance_with
      • ForecastItemConfig.cap
      • ForecastItemConfig.copy()
      • ForecastItemConfig.floor
      • ForecastItemConfig.make_forecast
      • ForecastItemConfig.manual_forecasts
      • ForecastItemConfig.method
      • ForecastItemConfig.pct_of
      • ForecastItemConfig.plug
      • ForecastItemConfig.prophet_kwargs
      • ForecastItemConfig.to_series()
  • finstmt.forecast.dataframe module
    • add_cap_and_floor_to_df()
  • finstmt.forecast.main module
    • Forecast
      • Forecast.__init__()
      • Forecast.base_config
      • Forecast.config
      • Forecast.copy()
      • Forecast.fit()
      • Forecast.item_config
      • Forecast.name
      • Forecast.orig_series
      • Forecast.pct_of_config
      • Forecast.pct_of_series
      • Forecast.plot()
      • Forecast.predict()
      • Forecast.result
      • Forecast.series
      • Forecast.to_manual()
  • finstmt.forecast.plot module
    • plot_forecast()
  • finstmt.forecast.statements module
    • ForecastedFinancialStatements
      • ForecastedFinancialStatements.__init__()
      • ForecastedFinancialStatements.forecasts
      • ForecastedFinancialStatements.plot()
• finstmt.inc package
  • Submodules
  • finstmt.inc.config module
  • finstmt.inc.main module
    • IncomeStatements
      • IncomeStatements.__init__()
      • IncomeStatements.items_config_list
      • IncomeStatements.statement_name
      • IncomeStatements.statements
• finstmt.items package
  • Submodules
  • finstmt.items.config module
    • ItemConfig
      • ItemConfig.__init__()
      • ItemConfig.copy()
      • ItemConfig.display_name
      • ItemConfig.display_verbosity
      • ItemConfig.expr_str
      • ItemConfig.extract_names
      • ItemConfig.force_positive
      • ItemConfig.forecast_config
      • ItemConfig.key
      • ItemConfig.primary_name
• finstmt.loaders package
  • Submodules
  • finstmt.loaders.capiq module
    • load_capiq_df()
• finstmt.resolver package
  • Submodules
  • finstmt.resolver.base module
    • ResolverBase
      • ResolverBase.__init__()
      • ResolverBase.all_eqs
      • ResolverBase.num_periods
      • ResolverBase.set_solve_eqs_and_full_subs_dict()
      • ResolverBase.solve_eqs
      • ResolverBase.subs_dict
      • ResolverBase.sympy_subs_dict
      • ResolverBase.t
      • ResolverBase.t_indexed_eqs
      • ResolverBase.to_statements()
  • finstmt.resolver.forecast module
    • BalanceSheetBalancedException
    • ForecastResolver
      • ForecastResolver.__init__()
      • ForecastResolver.all_eqs
      • ForecastResolver.bs_balance_eqs
      • ForecastResolver.forecast_dates
      • ForecastResolver.num_periods
      • ForecastResolver.plug_configs
      • ForecastResolver.plug_keys
      • ForecastResolver.plug_x0
      • ForecastResolver.resolve_balance_sheet()
      • ForecastResolver.solve_eqs
      • ForecastResolver.subs_dict
      • ForecastResolver.sympy_subs_dict
      • ForecastResolver.t_indexed_eqs
      • ForecastResolver.to_statements()
    • PlugResult
      • PlugResult.__init__()
      • PlugResult.fun
      • PlugResult.is_timed_out
      • PlugResult.met_goal
      • PlugResult.res
      • PlugResult.start_time
      • PlugResult.time_elapsed
      • PlugResult.timeout
    • resolve_balance_sheet()
  • finstmt.resolver.history module
    • StatementsResolver
      • StatementsResolver.all_eqs
      • StatementsResolver.num_periods
      • StatementsResolver.solve_eqs
      • StatementsResolver.subs_dict
      • StatementsResolver.sympy_subs_dict
      • StatementsResolver.t_indexed_eqs
      • StatementsResolver.to_statements()
  • finstmt.resolver.solve module
    • get_solve_eqs_and_full_subs_dict()
    • numpy_solve()
    • results_dict_to_sympy_dict()
    • solve_equations()
    • sympy_dict_to_results_dict()

Submodules

finstmt.check module

finstmt.check.item_series_is_empty(s)

Return type:

bool

finstmt.exc module

exception finstmt.exc.BalanceSheetNotBalancedException

Bases: ForecastException

exception finstmt.exc.CouldNotParseException

Bases: FinstmtException

exception finstmt.exc.FinstmtException

Bases: Exception

exception finstmt.exc.ForecastException

Bases: FinstmtException

exception finstmt.exc.ForecastNotFitException

Bases: ForecastException

exception finstmt.exc.ForecastNotPredictedException

Bases: ForecastException

exception finstmt.exc.ImproperManualForecastException

Bases: ForecastException

exception finstmt.exc.InvalidBalanceConfigException

Bases: ForecastException

exception finstmt.exc.InvalidBalancePlugsException

Bases: ForecastException

exception finstmt.exc.InvalidForecastEquationException

Bases: ForecastException

exception finstmt.exc.MismatchingDatesException

Bases: FinstmtException

exception finstmt.exc.MissingDataException

Bases: FinstmtException

exception finstmt.exc.MixedFrequencyException

Bases: FinstmtException

exception finstmt.exc.NoSuchItemException

Bases: FinstmtException

exception finstmt.exc.NotACalculatedItemException

Bases: FinstmtException

finstmt.logger module