📢 Announcement

Good news! You can now use a patched version of the library empyrical through EigenLedger! 🎉
👉 Learn how to use it here and read more in this announcement post.

By Investors, For Investors.

Want to read this in Mandarin 🇨🇳? Click here

EigenLedger (prev. "Empyrial") is a Python-based open-source quantitative investment library dedicated to financial institutions and retail investors, officially released in 2021. Already used by thousands of people working in the finance industry, EigenLedger aims to become an all-in-one platform for portfolio management, analysis, and optimization.

EigenLedger empowers portfolio management by bringing the best of performance and risk analysis in an easy-to-understand, flexible and powerful framework.

With EigenLedger, you can easily analyze security or a portfolio in order to get the best insights from it. This is mainly a wrapper of financial analysis libraries such as Quantstats and PyPortfolioOpt.

Table of Contents 📖
1. Installation
2. Documentation
3. Quickstart
4. Contribution and Issues
5. Contributors
6. Contact
7. License

Installation

You can install EigenLedger using pip:

pip install EigenLedger

For a better experience, we advise you to use EigenLedger on a notebook (e.g., Jupyter, Google Colab)

Note: macOS users will need to install Xcode Command Line Tools.

Note: Windows users will need to install C++. (download, install instructions)

Documentation

Here is our full documentation! Check it out our full documentation for detailed guides, all features, and tips on getting the most out of this library.

Quickstart

from EigenLedger import portfolio_analysis, Engine

portfolio = Engine(
    start_date = "2018-08-01", 
    portfolio = ["BABA", "PDD", "KO", "AMD","^IXIC"], 
    weights = [0.2, 0.2, 0.2, 0.2, 0.2],  # equal weighting is set by default
    benchmark = ["SPY"]  # SPY is set by default
)

portfolio_analysis(portfolio)

Stargazers over time

Contribution and Issues

EigenLedger uses GitHub to host its source code. Learn more about the Github flow.

For larger changes (e.g., new feature request, large refactoring), please open an issue to discuss first.

• If you wish to create a new Issue, then click here to create a new issue.

Smaller improvements (e.g., document improvements, bugfixes) can be handled by the Pull Request process of GitHub: pull requests.

• To contribute to the code, you will need to do the following:

• Fork EigenLedger - Click the Fork button at the upper right corner of this page.

• Clone your own fork. E.g., git clone https://github.com/ssantoshp/EigenLedger.git
  If your fork is out of date, then will you need to manually sync your fork: Synchronization method

• Create a Pull Request using your fork as the compare head repository.

You contributions will be reviewed, potentially modified, and hopefully merged into EigenLedger.

Contributors

Thanks goes to these wonderful people (emoji key):

Brendan Glancy 💻 🐛

Renan Lopes 💻 🐛

Mark Thebault 💻

Diego Alvarez 💻🐛

Rakesh Bhat 💻

Anh Le 🐛

Tony Zhang 💻

Ikko Ashimine ✒️

QuantNomad 📹

Buckley ✒️💻

Adam Nelsson 💻

Ranjan Grover 🐛💻

This project follows the all-contributors specification. Contributions of any kind are welcome!

Credit

This library has also been made possible because of the work of these incredible people:

• Ran Aroussi for the Quantstats library
• Robert Martin for the PyPortfolioOpt

Contact

You are welcome to contact us by email at [email protected] or in EigenLedger's discussion space

License

Apache License 2.0