Code Monkey home page Code Monkey logo

famafrench-1's Introduction

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 [email protected].

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.

famafrench-1's People

Contributors

christianjauregui avatar codacy-badger avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.