Metadata-Version: 2.1
Name: stockhold
Version: 0.0.1
Summary: stock hold analysis
Author-email: Vamsee Achanta <vamsee.achanta@aceengineer.com>
License: MIT License
        
        Copyright (c) 2022 Vamsee Achanta
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: repository, https://github.com/vamseeachanta/stockhold
Project-URL: documentation, https://github.com/vamseeachanta/stockhold/blob/main/README.md
Keywords: stock analysis,stock hold,back analysis,investment
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: pyyaml
Requires-Dist: numpy-financial
Requires-Dist: bumpver
Requires-Dist: plotly
Requires-Dist: dash
Requires-Dist: dash-bootstrap-components
Requires-Dist: urllib3
Requires-Dist: xmltodict
Requires-Dist: bs4
Requires-Dist: sqlalchemy
Requires-Dist: yfinance
Requires-Dist: yahoo-fin
Requires-Dist: finvizfinance
Requires-Dist: sec-edgar-downloader
Requires-Dist: ta
Requires-Dist: flask-wtf
Requires-Dist: flask-httpauth
Requires-Dist: flask-restful
Provides-Extra: build
Requires-Dist: build ; extra == 'build'
Requires-Dist: twine ; extra == 'build'
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: bumpver ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'

# StockHoldAnalysis

Stock analysis, logic and guidance for long-term holding of a stock market asset trading on US stock exchanges i.e. Nasdaq etc.

Helps manage a stock as a stand-alone portfolio

# Summary


# Usage

See test file for example ticker, [test file](https://github.com/vamseeachanta/stockhold/blob/master/src/stockhold/tests/test_stock_visualization_for_ticker_text_area.py)

Analysis output is: 
https://github.com/vamseeachanta/stockhold/blob/master/docs/2022-11-26_RIG_Analysis.png


See a [test file](https://github.com/vamseeachanta/stockhold/blob/master/src/stockhold/test/test_all_analysis_xom.py) to see how to perform analysis




## Technical Details

Mapping Dashboard UI to the financial analysis

| Analysis     | Code class | Code object   | Current Status | Description | 
|----------|------------|---------------|----------------|-----------|
| Insider <br> Insider Cost and Volumes | fc.fanalysis | insider_df_buy <br> insider_df_sell | done | - [x] ok?
| Insider <br> Relation | fc.fanalysis | insider_analysis_by_relation_df | done | - [x] ok?
| Insider <br> Timeline | fc.fanalysis | insider_analysis_by_timeline_df | done | - [x] ok?
| Insider <br> Relative Buy | fc.fanalysis | insider_df_buy | done | - [x] ok?
| Insider <br> Relative Sell | fc.fanalysis | insider_df_sell | done | - [x] ok?
| Institution <br> Institution | fc.fanalysis | df_institutional_holders | done | - [x] ok?
| Price <br> Price | fc.fanalysis | ta | done | - [x] ok?
| Technical <br> Volume | fc.fanalysis | ta | done | - [x] ok?
| Technical <br> cfm | fc.fanalysis | ta | done | - [x] ok?
| Technical <br> eom | fc.fanalysis | ta | done | - [x] ok?
| Technical <br> wt_price | fc.fanalysis | ta | done | - [x] ok?
| Technical <br> volatility | fc.fanalysis | ta | done | - [x] ok?
| Technical <br> volatility_hi_low | fc.fanalysis | ta | done | - [x] ok?
| Technical <br> ulcer | fc.fanalysis | ta | done | - [x] ok?
| Technical <br> strength | fc.fanalysis | ta | done | - [x] ok?
| Option <br> Call | fc.fanalysis | df_call_analysis | done | - [x] ok?
| Option <br> Put | fc.fanalysis | TBA | done | - [x] ok?

## Debt

Library TODO list to keep track of ideas.

**TODO**

- Add summary for all key analysis to help make faster decisions.
- Add insider ranking for relative comparison between tickers
- Troubleshoot SEC data import. Advise users to put appropriate headers to avoid lock-out by SEC websites
- Add Logic Flowchart

## References

https://www.lynalden.com/covered-calls/

Getting into and out of stocks:
https://www.marketwatch.com/story/plan-now-when-to-get-back-into-stocks-11657920632
