<p align="center"><img src="/assets/investos-banner.png" alt="InvestOS Banner"></p>
<h1 align="center">InvestOS</h1>
Welcome to the **InvestOS** portfolio engineering and backtesting framework!
InvestOS is an opinionated framework for constructing and backtesting portfolios in a consistent, albeit flexible way. We built it to make institutional-grade backtesting and portfolio optimization simple, extensible, and open-source.
<br/>
| | |
| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Docs | [](https://investos.io/) [](https://investos.readthedocs.io/en/latest/) |
| Package | [](https://pypi.python.org/pypi/investos) [](https://pypi.org/project/investos/) |
| Meta | [](https://python-poetry.org/) [](https://github.com/astral-sh/ruff) [](https://spdx.org/licenses/CC-BY-NC-SA-4.0.html) |
<br/>
## Getting Started
### 🔗 [Read the full Getting Started guides Here](https://investos.io/guides/introduction/getting_started)
### Prerequisites
**To run InvestOS you'll need**:
- [Python +3.8](https://www.python.org/doc/)
- You can [download it here](https://www.python.org/downloads/)
- If you're working on MacOS, you may wish to [install it via Homebrew](https://docs.python-guide.org/starting/install3/osx/)
- [pip](https://packaging.python.org/en/latest/key_projects/#pip)
- For installing InvestOS (and any other Python packages)
- [pip installation instructions here](https://packaging.python.org/en/latest/tutorials/installing-packages/)
**Although not required, running InvestOS might be easier if you have**:
- [Poetry](https://python-poetry.org/), a package and dependency manager
- Familiarity with [pandas](https://pandas.pydata.org/)
- The popular Python data analysis package (originally) released by AQR Capital Management
## Installation
If you're using pip:
```bash
$ pip install investos
```
If you're using poetry:
```bash
$ poetry add investos
```
## Importing InvestOS
At the top of your python file or .ipynb, add:
```python
import investos as inv
```
Congratulations on setting up InvestOS!
### Let's move on to our next guide: [How InvestOS Works](https://investos.io/guides/introduction/how_investos_works)
## Contributing
InvestOS is an open-source project and we welcome contributions from the community.
If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.
### Contributors ✨
<a href="https://github.com/forecastos/investos/contributors">
<img src="https://contrib.rocks/image?repo=forecastos/investos" />
</a>
Raw data
{
"_id": null,
"home_page": "https://investos.io/",
"name": "investos",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "investing, alpha, backtesting, portfolio, optimization, forecastos",
"author": "Charlie Reese",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/36/0b/94cc0030d6c12149b244407a9515327b224097241a7b17b36452764debf5/investos-0.5.5.tar.gz",
"platform": null,
"description": "<p align=\"center\"><img src=\"/assets/investos-banner.png\" alt=\"InvestOS Banner\"></p>\n<h1 align=\"center\">InvestOS</h1>\n\nWelcome to the **InvestOS** portfolio engineering and backtesting framework!\n\nInvestOS is an opinionated framework for constructing and backtesting portfolios in a consistent, albeit flexible way. We built it to make institutional-grade backtesting and portfolio optimization simple, extensible, and open-source.\n\n<br/>\n\n| | |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Docs | [](https://investos.io/) [](https://investos.readthedocs.io/en/latest/) |\n| Package | [](https://pypi.python.org/pypi/investos) [](https://pypi.org/project/investos/) |\n| Meta | [](https://python-poetry.org/) [](https://github.com/astral-sh/ruff) [](https://spdx.org/licenses/CC-BY-NC-SA-4.0.html) |\n\n<br/>\n\n## Getting Started\n\n### \ud83d\udd17 [Read the full Getting Started guides Here](https://investos.io/guides/introduction/getting_started)\n\n### Prerequisites\n\n**To run InvestOS you'll need**:\n\n- [Python +3.8](https://www.python.org/doc/)\n - You can [download it here](https://www.python.org/downloads/)\n - If you're working on MacOS, you may wish to [install it via Homebrew](https://docs.python-guide.org/starting/install3/osx/)\n- [pip](https://packaging.python.org/en/latest/key_projects/#pip)\n - For installing InvestOS (and any other Python packages)\n - [pip installation instructions here](https://packaging.python.org/en/latest/tutorials/installing-packages/)\n\n**Although not required, running InvestOS might be easier if you have**:\n\n- [Poetry](https://python-poetry.org/), a package and dependency manager\n- Familiarity with [pandas](https://pandas.pydata.org/)\n - The popular Python data analysis package (originally) released by AQR Capital Management\n\n## Installation\n\nIf you're using pip:\n\n```bash\n$ pip install investos\n```\n\nIf you're using poetry:\n\n```bash\n$ poetry add investos\n```\n\n## Importing InvestOS\n\nAt the top of your python file or .ipynb, add:\n\n```python\nimport investos as inv\n```\n\nCongratulations on setting up InvestOS!\n\n### Let's move on to our next guide: [How InvestOS Works](https://investos.io/guides/introduction/how_investos_works)\n\n## Contributing\n\nInvestOS is an open-source project and we welcome contributions from the community.\n\nIf you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.\n\n### Contributors \u2728\n\n<a href=\"https://github.com/forecastos/investos/contributors\">\n <img src=\"https://contrib.rocks/image?repo=forecastos/investos\" />\n</a>\n",
"bugtrack_url": null,
"license": "Creative Commons Attribution-NonCommercial-ShareAlike (CC-BY-NC-SA)",
"summary": "Reliable backtesting and portfolio optimization for investors who want to focus on generating alpha",
"version": "0.5.5",
"project_urls": {
"Documentation": "https://investos.readthedocs.io/en/latest/",
"Homepage": "https://investos.io/",
"Repository": "https://github.com/forecastos/investos"
},
"split_keywords": [
"investing",
" alpha",
" backtesting",
" portfolio",
" optimization",
" forecastos"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b3e97ae88d0abfd62acd7f60a02d6231f1e32294dddcfbc80b7bfbf80790f5e6",
"md5": "375db0e765cd1685a305d7fcbb3bc68c",
"sha256": "156dc1434b81923c77771481702f60b326f0340e48ca4d6f010124d33013cf61"
},
"downloads": -1,
"filename": "investos-0.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "375db0e765cd1685a305d7fcbb3bc68c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 43595,
"upload_time": "2024-08-16T22:15:40",
"upload_time_iso_8601": "2024-08-16T22:15:40.844974Z",
"url": "https://files.pythonhosted.org/packages/b3/e9/7ae88d0abfd62acd7f60a02d6231f1e32294dddcfbc80b7bfbf80790f5e6/investos-0.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "360b94cc0030d6c12149b244407a9515327b224097241a7b17b36452764debf5",
"md5": "c43a4f86fcdec9e96920c9bc8e506810",
"sha256": "014619919148166990c9bf41da7bfa844d23602c5453095fb0634d6b8bb35f5a"
},
"downloads": -1,
"filename": "investos-0.5.5.tar.gz",
"has_sig": false,
"md5_digest": "c43a4f86fcdec9e96920c9bc8e506810",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 32970,
"upload_time": "2024-08-16T22:15:42",
"upload_time_iso_8601": "2024-08-16T22:15:42.352015Z",
"url": "https://files.pythonhosted.org/packages/36/0b/94cc0030d6c12149b244407a9515327b224097241a7b17b36452764debf5/investos-0.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-16 22:15:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "forecastos",
"github_project": "investos",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "investos"
}
JSON
