# f4ratk
[](https://pypi.org/project/f4ratk/)
[](https://pypi.org/project/f4ratk/)
[](https://spdx.org/licenses/AGPL-3.0-only.html)
[](https://ci.codeberg.org/repos/11453)
[](https://pypistats.org/packages/f4ratk)
[](https://liberapay.com/f4ratk/donate)
A Fama/French Finance Factor Regression Analysis Toolkit.
The deployed project is provided at https://f4ratk.web.app.
## Here be dragons
This project is experimental: it does not provide any guarantees and its
results are not rigorously tested. It should not be used by itself as a
basis for decision‐making.
If you would like to join, please see [CONTRIBUTING] for guidelines.
## Features
The following lists some main use cases, this software can assist you.
- Analyze stock quotes of a ticker symbol.
- Analyze arbitrary performance data from file.
- Display historic factor returns.
- Estimate excess returns based on regression results.
## Quickstart
### Installation
Obtain the latest released version of f4ratk using pip:
`pip install -U f4ratk`
### Usage
Run the program to see an interactive help. Note that each listed
command also provides an individual help.
`f4ratk --help`
```lang-none
Usage: f4ratk [OPTIONS] COMMAND [ARGS]...
Options:
-v, --verbose Increase output verbosity.
--about Display program information and exit.
--help Show this message and exit.
Commands:
convert Convert files to the 'file' command format.
file Analyze a CSV file.
history Display historic factor returns.
portfolio Analyze a portfolio file.
ticker Analyze a ticker symbol.
```
Adjust the program arguments according to your problem.
Then run your regression analysis similar to the following.
#### Examples
```lang-sh
f4ratk ticker USSC.L US USD
f4ratk file ./input.csv DEVELOPED EUR PRICE --frequency=MONTHLY
```
## License
This project is licensed under the GNU Affero General Public License
version 3 (only). See [LICENSE] for more information and [COPYING]
for the full license text.
[CONTRIBUTING]: https://codeberg.org/toroettg/f4ratk/src/branch/main/CONTRIBUTING.md
[LICENSE]: https://codeberg.org/toroettg/f4ratk/src/branch/main/LICENSE
[COPYING]: https://codeberg.org/toroettg/f4ratk/src/branch/main/COPYING
Raw data
{
"_id": null,
"home_page": "https://codeberg.org/toroettg/f4ratk",
"name": "f4ratk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<3.12",
"maintainer_email": "",
"keywords": "finance,fama,regression",
"author": "Tobias R\u00f6ttger",
"author_email": "dev@roettger-it.de",
"download_url": "https://files.pythonhosted.org/packages/24/3e/4f23959669aa0e803ec47de084250ca7fc8114b420cfe1af9a72ce0905dd/f4ratk-2023.1.tar.gz",
"platform": null,
"description": "# f4ratk\n\n[](https://pypi.org/project/f4ratk/)\n[](https://pypi.org/project/f4ratk/)\n[](https://spdx.org/licenses/AGPL-3.0-only.html)\n[](https://ci.codeberg.org/repos/11453)\n[](https://pypistats.org/packages/f4ratk)\n[](https://liberapay.com/f4ratk/donate)\n\nA Fama/French Finance Factor Regression Analysis Toolkit.\n\nThe deployed project is provided at https://f4ratk.web.app.\n\n## Here be dragons\n\nThis project is experimental: it does not provide any guarantees and its\nresults are not rigorously tested. It should not be used by itself as a\nbasis for decision\u2010making.\n\nIf you would like to join, please see [CONTRIBUTING] for guidelines.\n\n## Features\n\nThe following lists some main use cases, this software can assist you.\n\n- Analyze stock quotes of a ticker symbol.\n- Analyze arbitrary performance data from file.\n- Display historic factor returns.\n- Estimate excess returns based on regression results.\n\n## Quickstart\n\n### Installation\n\nObtain the latest released version of f4ratk using pip:\n\n`pip install -U f4ratk`\n\n### Usage\n\nRun the program to see an interactive help. Note that each listed\ncommand also provides an individual help.\n\n`f4ratk --help`\n\n```lang-none\nUsage: f4ratk [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n -v, --verbose Increase output verbosity.\n --about Display program information and exit.\n --help Show this message and exit.\n\nCommands:\n convert Convert files to the 'file' command format.\n file Analyze a CSV file.\n history Display historic factor returns.\n portfolio Analyze a portfolio file.\n ticker Analyze a ticker symbol.\n\n```\n\nAdjust the program arguments according to your problem.\nThen run your regression analysis similar to the following.\n\n#### Examples\n\n```lang-sh\nf4ratk ticker USSC.L US USD\nf4ratk file ./input.csv DEVELOPED EUR PRICE --frequency=MONTHLY\n\n```\n\n## License\n\nThis project is licensed under the GNU Affero General Public License\nversion 3 (only). See [LICENSE] for more information and [COPYING]\nfor the full license text.\n\n[CONTRIBUTING]: https://codeberg.org/toroettg/f4ratk/src/branch/main/CONTRIBUTING.md\n[LICENSE]: https://codeberg.org/toroettg/f4ratk/src/branch/main/LICENSE\n[COPYING]: https://codeberg.org/toroettg/f4ratk/src/branch/main/COPYING\n",
"bugtrack_url": null,
"license": "AGPL-3.0-only",
"summary": "A Fama/French Finance Factor Regression Analysis Toolkit.",
"version": "2023.1",
"project_urls": {
"Donate": "https://liberapay.com/f4ratk/donate",
"Homepage": "https://codeberg.org/toroettg/f4ratk",
"Issue Tracker": "https://codeberg.org/toroettg/f4ratk/issues",
"Repository": "https://codeberg.org/toroettg/f4ratk",
"Source Code": "https://codeberg.org/toroettg/f4ratk"
},
"split_keywords": [
"finance",
"fama",
"regression"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "375eb94922707dd9325fcdaca5ef6d077314ddf6a19c828fe6d33aff24f9cbc8",
"md5": "541783278f0e1c846731e30f0277de02",
"sha256": "cdc9bfb553639ed3479325966289ea3986a3367b8b99e6d140b71a7ba240992b"
},
"downloads": -1,
"filename": "f4ratk-2023.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "541783278f0e1c846731e30f0277de02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<3.12",
"size": 63681,
"upload_time": "2023-11-19T12:35:16",
"upload_time_iso_8601": "2023-11-19T12:35:16.807027Z",
"url": "https://files.pythonhosted.org/packages/37/5e/b94922707dd9325fcdaca5ef6d077314ddf6a19c828fe6d33aff24f9cbc8/f4ratk-2023.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "243e4f23959669aa0e803ec47de084250ca7fc8114b420cfe1af9a72ce0905dd",
"md5": "a75add74c1af15a0bc2c19121924fb71",
"sha256": "321c52b9118329055dc04bb5d4687792cb0a805d2fbe0a71087c46aaa343ff51"
},
"downloads": -1,
"filename": "f4ratk-2023.1.tar.gz",
"has_sig": false,
"md5_digest": "a75add74c1af15a0bc2c19121924fb71",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<3.12",
"size": 36350,
"upload_time": "2023-11-19T12:35:18",
"upload_time_iso_8601": "2023-11-19T12:35:18.622356Z",
"url": "https://files.pythonhosted.org/packages/24/3e/4f23959669aa0e803ec47de084250ca7fc8114b420cfe1af9a72ce0905dd/f4ratk-2023.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-19 12:35:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": true,
"codeberg_user": "toroettg",
"codeberg_project": "f4ratk",
"lcname": "f4ratk"
}
JSON