calcbench / python_api_client Goto Github PK

View Code? Open in Web Editor NEW

20.0 9.0 10.0 1.73 MB

A Python client for Calcbench's API.

Python 99.93% PowerShell 0.07%

python finance xbrl fundamentals accounting

python_api_client's People

Contributors

Stargazers

Watchers

Forkers

civics richardkhoo pebsconsulting dshen1 jj48642 flyingisland drtonylin semenodp maharris77 firmai-research

python_api_client's Issues

Sphinx documentation for downloaders is wonky

Sphinx is not building the correct documentation for the last two functions.

Add to Anaconda Repository

Use key-ring and windows credentials manager for credentials

make standardized columns categorical

ticker, metric, CIK etc can be categories

KeyError: 'first_filing' in companies function

I am attempting to run the following line cb.companies(SIC_codes=[1100], entire_universe=True, NAICS_codes=[213112], include_most_recent_filing_dates=False) and getting this error

/usr/local/lib/python3.6/dist-packages/calcbench/companies.py in companies(SIC_codes, index, company_identifiers, entire_universe, include_most_recent_filing_dates, NAICS_codes)
     77     companies = pd.DataFrame(companies)
     78     for column in ["first_filing", "most_recent_filing", "most_recent_full_year_end"]:
---> 79         companies[column] = pd.to_datetime(companies[column], errors="coerce")
     80     return companies
     81 

/usr/local/lib/python3.6/dist-packages/pandas/core/frame.py in __getitem__(self, key)
   2904             if self.columns.nlevels > 1:
   2905                 return self._getitem_multilevel(key)
-> 2906             indexer = self.columns.get_loc(key)
   2907             if is_integer(indexer):
   2908                 indexer = [indexer]

/usr/local/lib/python3.6/dist-packages/pandas/core/indexes/base.py in get_loc(self, key, method, tolerance)
   2898                 return self._engine.get_loc(casted_key)
   2899             except KeyError as err:
-> 2900                 raise KeyError(key) from err
   2901 
   2902         if tolerance is not None:

KeyError: 'first_filing'

Add metric definitions to NonXBRLFact class

PR API GUIDE.docx

make long description markdown

Tighten up date parsing for standardized data

This does not work consistently.

python_api_client/calcbench/standardized_numeric.py

Line 511 in a4cf20a

data[date_column] = pd.to_datetime(data[date_column], errors="coerce")

Make the date_downloaded New York time so it aligns with the other time stamps

Add get_standardized_data to filing objects

filings = cb.filings(update_date=today)
for f in filings:
print(f.get_standardized_data())

disclosure_dataframe Usage example gives "UnboundLocalError"

Hi,
This is the example straight from the documentation and same result when I tried the "disclosure_nlp.ipynb" notebook:

import calcbench as cb
data = cb.disclosure_dataframe(
company_identifiers=["msft", "goog"],
all_history=True,  
disclosure_names=["ManagementsDiscussionAndAnalysis", "RiskFactors"])  
UnboundLocalError: local variable 'quarter' referenced before assignment

add end-point for press-release data

Verify credentials before saving to keychain

If the credentials are incorrect you should not save them to the keychain

TypeError: normalized_raw() got an unexpected keyword argument 'accesion_id'

When running the following example (https://github.com/calcbench/notebooks/blob/master/python_client_api_demo.ipynb), there is an exception from standardized_data function

TypeError                                 Traceback (most recent call last)

<ipython-input-44-ecfcb69ac1de> in <module>()
      4     year=2020,
      5     period=1,
----> 6     accesion_id=None
      7 )

/usr/local/lib/python3.6/dist-packages/calcbench/standardized_numeric.py in normalized_dataframe(company_identifiers, metrics, start_year, start_period, end_year, end_period, entire_universe, point_in_time, year, period, all_history, period_type, trace_hyperlinks, use_fiscal_period, company_identifier_scheme, accesion_id)

TypeError: normalized_raw() got an unexpected keyword argument 'accesion_id'

Allow fiscal_year and fiscal_period on standardized to be iterables

Should be able to pass more than one year/period