Metadata-Version: 2.4
Name: investing-navigator
Version: 1.0.0
Summary: Investing Navigator is an intelligent investing assistant that helps users explore investment opportunities, understand financial concepts, and navigate the markets with greater confidence.
Home-page: https://getoninvesting.com
Author: GetOnInvesting.com
Author-email: "GetOnInvesting.com" <info@getoninvesting.com>
License: MIT License
        
        Copyright (c) 2026 GetOnInvesting.com
        
        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: Homepage, https://getoninvesting.com
Project-URL: GitHub, https://github.com/get-on-investing/Investing-Navigator
Project-URL: Documentation, https://investing-navigator.readthedocs.io
Project-URL: PyPI, https://pypi.org/project/investing-navigator
Keywords: investing-navigator,investment-assistant,portfolio-planning,financial-education,market-navigation,wealth-building,getoninvesting
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# Investing Navigator 📈🧭

[![npm](https://img.shields.io/npm/v/@get-on-investing/investing-navigator)](https://npmjs.com/package/@get-on-investing/investing-navigator)
[![PyPI](https://img.shields.io/pypi/v/investing-navigator)](https://pypi.org/project/investing-navigator)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.21646993.svg)](https://doi.org/10.5281/zenodo.21646993)

Investing Navigator is an intelligent investing assistant from Get On Investing that helps users explore investment opportunities, understand financial concepts, and navigate the markets with greater confidence. Built by [GetOnInvesting.com](https://getoninvesting.com).

## Features

- Portfolio Readiness Score — evaluates investment portfolio structure and diversification
- Market Knowledge Score — measures understanding of financial markets and instruments
- Risk Assessment Score — evaluates risk tolerance and portfolio risk alignment
- Wealth Building Score — tracks progress toward long-term wealth building goals
- Investment Education Score — measures financial literacy and investing knowledge
- Market Navigation Score — evaluates ability to navigate market conditions confidently
- CLI support in Node.js and Python
- Benchmark dataset included (20 investor profile cases)
- Lightweight, publish-ready, minimal dependencies

## Quick Start

### Node.js

```bash
npm install @get-on-investing/investing-navigator
npx investing-navigator "investor-profile" beginner 75 68 80 72 85 70
```

### Python

```bash
pip install investing-navigator
python -m navigator "investor-profile" beginner 75 68 80 72 85 70
```

## Output

```
Investor: investor-profile
Experience Level: Beginner
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Portfolio Readiness Score:     75 / 100  [Healthy]
Market Knowledge Score:        68 / 100  [Healthy]
Risk Assessment Score:         80 / 100  [Healthy]
Wealth Building Score:         72 / 100  [Healthy]
Investment Education Score:    85 / 100  [Excellent]
Market Navigation Score:       70 / 100  [Healthy]
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Overall Navigator Score:       75 / 100
Priority Action:               Market Knowledge (lowest — act first)

Investment Focus Areas:
  Stocks & Equities:      75 / 100
  Bonds & Fixed Income:   72 / 100
  ETFs & Index Funds:     80 / 100
  Real Estate (REITs):    68 / 100
```

## Investor Experience Levels

| Level | Description |
|-------|-------------|
| beginner | New to investing — learning fundamentals |
| intermediate | Some experience — building portfolio |
| advanced | Experienced — optimising strategies |
| expert | Professional — managing complex portfolios |

## Project Structure

```
Investing-Navigator/
├── index.ts              # TypeScript navigator
├── navigator.py          # Python navigator
├── setup.py              # PyPI setup config
├── pyproject.toml        # PyPI build config
├── package.json          # NPM package config
├── package-lock.json     # NPM lock file
├── tsconfig.json         # TypeScript config
├── schema.json           # JSON-LD structured data
├── zenodo.json           # Zenodo metadata
├── heartbeat.txt         # Auto-updated daily
├── mkdocs.yml            # ReadTheDocs config
├── .readthedocs.yaml     # ReadTheDocs build config
├── docs/
│   ├── index.md          # Documentation
│   └── requirements.txt
├── dataset/
│   └── investing_benchmarks.csv
├── kaggle/
│   └── notebook.ipynb
├── .github/workflows/
│   ├── heartbeat.yml
│   ├── npm-publish.yml
│   └── pypi-publish.yml
├── README.md
└── LICENSE
```

## Investment Signal Scores

| Signal | Description | Score Range |
|--------|-------------|-------------|
| Portfolio Readiness | Portfolio structure and diversification | 0–100 |
| Market Knowledge | Understanding of financial markets | 0–100 |
| Risk Assessment | Risk tolerance and portfolio alignment | 0–100 |
| Wealth Building | Progress toward long-term wealth goals | 0–100 |
| Investment Education | Financial literacy and investing knowledge | 0–100 |
| Market Navigation | Ability to navigate market conditions | 0–100 |

## Score Interpretation

| Score | Status | Action |
|-------|--------|--------|
| 0–30 | Critical | Immediate learning intervention required |
| 31–60 | At Risk | Active education and guidance needed |
| 61–80 | Healthy | On track — continue building knowledge |
| 81–100 | Excellent | Strong investor — ready for advanced strategies |

## Keywords

Investing Navigator · Investment Assistant · Portfolio Planning · Financial Education · Market Navigation · Wealth Building · Investment Learning · Get On Investing

## Links

| Platform | URL |
|----------|-----|
| Website | https://getoninvesting.com |
| GitHub | https://github.com/get-on-investing/Investing-Navigator |
| GitHub Pages | https://get-on-investing.github.io/Investing-Navigator/ |
| NPM | https://npmjs.com/package/@get-on-investing/investing-navigator |
| PyPI | https://pypi.org/project/investing-navigator |
| Hugging Face | https://huggingface.co/datasets/get-on-investing/investing-navigator-benchmarks |
| Kaggle | https://kaggle.com/datasets/getoninvesting/investing-navigator-benchmarks |
| Zenodo | https://zenodo.org/records/21646993 |
| Docs | https://investing-navigator.readthedocs.io |

## About GetOnInvesting.com

GetOnInvesting.com is an intelligent investing platform helping users explore investment opportunities, understand financial concepts, and navigate the markets with greater confidence through organised investing knowledge, portfolio insights, and practical guidance.

## License

MIT — [GetOnInvesting.com](https://getoninvesting.com)
