Skip to main content

Python package designed to construct and replicate datasets from Ken French's online library (https://mba.tuck.dartmouth.edu/pages/faculty/ken.french/data_library.html) via remote access to wrds-cloud.

Project description

famafrench

famafrench is a Python library package designed to replicate and construct datasets from
Ken French's online data library via remote access to the wrds-cloud by querying CRSP, Compustat Fundamentals Annual, and other datafiles.

This module uses the WRDS-Py library package to extract data from CRPS, Compustat Fundamentals Annual, and other datafiles via the cloud for use with the Pandas-Py package.

famafrench's current efficient performance results from features such as the use of a least recently used (LRU) cache implemented using the Python decorator functools.lru_cache.

Metric
Supports Python 3.4+
forthebadge made-with-python
Python 3
Latest Release GitHub Release Date
PyPI version
Code Quality Updates
Codacy Badge
Citation DOI
License License
Documentation made-with-sphinx-doc
documentation Status
Contributing contributions welcome
HitCount! HitCount

famafrench is best explored by going through applications and examples provided in the released documentation hosted on Github Pages.

Module Contents

Module Description
famafrench.py Main module w/ tools for constructing and replicating datasets from Ken French’s online library via queries to WRDS.
utils.py Auxiliary functions and utilities for use in the main module famafrench.py.
wrdsconnect.py Enables remote connection to wrds-cloud largely building on the Connection() class in the WRDS-Py library.
version.py Module w/ package's version number.

Installation

The latest release is Release 0.1.4 as of May 12, 2020 (see documentation).

Python Package Index (pip)

Releases are available via PyPI and can be installed with pip.

pip install famafrench

Anaconda (conda)

Conda users will soon be able to install from my Anaconda channel. Stay tuned.

Dependencies

famafrench relies on a suite of Python libraries, which include Python's scientific computing stack (e.g. NumPy and Pandas). Other dependencies include Numba and SQLAlchemy.

Please see setup.py or requirements.txt for specific version threshold requirements.

Documentation

Released documentation is hosted on Github Pages. Look out for future updated documentation from my master branch hosted on Github.

Contributing

I welcome recommendations, contributions and/or future collaborations. I am ambitious and plan to expand the module to include construction of additional factor-based datasets relevant for empirical asset pricing. These include the following:

Performance and speed improvements are also appreciated.

Please report any bugs or errors to my github page or please send me an email at chris.jauregui@berkeley.edu.

API

For in-depth call syntaxes, please see the source code doctrings.

Disclaimer

This library and its affiliated content was created without any involvement by Kenneth R. French and Eugene F. Fama.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

famafrench-0.1.4.tar.gz (77.4 kB view hashes)

Uploaded Source

Built Distribution

famafrench-0.1.4-py3-none-any.whl (67.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page