Skip to main content

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.

Metadata

Release files for famafrench 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for famafrench 0.1.4
File Size Uploaded
famafrench-0.1.4.tar.gz 77.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for famafrench 0.1.4
File Interpreter ABI Platform
famafrench-0.1.4-py3-none-any.whl Python 3 none any Details

Total release size: 144.9 kB

Release files / famafrench-0.1.4.tar.gz

Download URL famafrench-0.1.4.tar.gz
Size 77.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f8695e049d7429d121a2d67cd531b954da84a8394ba754ca7ae7300a3b46724a
BLAKE2b-256 checksum
How to use checksums
dfee352fabd5756f173d0a1b378a7deb7e3c796b37d2fe504827a6ee5d64ef67
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.3

Release files / famafrench-0.1.4-py3-none-any.whl

Download URL famafrench-0.1.4-py3-none-any.whl
Size 67.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
24d5c9338d4d1b3228358ca2872c4f4cc414ca3c3a01c6f8f61b3c4e9648cead
BLAKE2b-256 checksum
How to use checksums
b054af9c2f35dc0bf4c90e0f7692438f5283dd3bbd51a3b9d11e7dd192be79c4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.3

Release history Release notifications | RSS feed

This release

0.1.4 This release

2 release files

0.1.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page