StockReport is a Python program that allows you to simply create an automated PDF report about a stock.
Installation
Before starting please install the following packages:
pip install alpha_vantage
pip install pandas
pip install fpdf
pip install plotly
pip install kaleido
Then install stock-report:
pip install stock-report
Usage
Alpha Vantage
This project is build with the Alpha Vantage API
You can request a free key at the following link: Claim API Key
Save your key as an environment variable
Mac
- From your terminal, type in:
export ALPHAVANTAGE_API_KEY=xxx - Make sure to use your actual API key for the value. You can confirm that the environment variable is saved by typing in the following which should display your API key:
echo $ALPHAVANTAGE_API_KEY
or
- From your terminal, type in:
nano .zshenv - In nano insert
export ALPHAVANTAGE_API_KEY=xxx - Close nano
- Restart
Windows
- Click Start and type in
environment variables. You should see an option to Edit environment variables for your account. - In the new window that pops up, click New under the User variables section.
- Your variable name should be
ALPHAVANTAGE_API_KEYand the variable value is where you can paste in your key.
Run
Run with:
python3 -m stock_report
You can find your pdf in the download folder.
Examples
You can view the examples here.
License
MIT See here
1 maintainer
Release files for stock-report 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| stock-report-1.0.0.tar.gz | 635.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| stock_report-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.3 MB
Release files / stock-report-1.0.0.tar.gz
| Download URL | stock-report-1.0.0.tar.gz |
|---|---|
| Size | 635.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
78f88449d2d9e4b903f289a5aeacc4e6359460d697324342051125e475368618
|
|
BLAKE2b-256 checksum How to use checksums |
57386fdbf551561e8e8d3518e1f55612fae9600f24c33ee0a1965eb561f8b169
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.9
|
Release files / stock_report-1.0.0-py3-none-any.whl
| Download URL | stock_report-1.0.0-py3-none-any.whl |
|---|---|
| Size | 634.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5843e2cb2db20b9c067a07766d62c71732da14fb983e6e56ee4e4a39dad8f810
|
|
BLAKE2b-256 checksum How to use checksums |
8e76bf8fb966d124f1d03ef552f8b06126ecad822d6aaac5e61a40b62b48e196
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.9
|
