Metadata-Version: 2.4
Name: stocksim
Version: 1.3.0
Summary: Monte Carlo Stock/Crypto Price Simulation Tool
Home-page: https://github.com/ElementalPublishing/StockSim
Author: Wesley Alexander Houser
Author-email: houser2388@gmail.com
License: MIT
Project-URL: Source, https://github.com/ElementalPublishing/StockSim
Project-URL: Tracker, https://github.com/ElementalPublishing/StockSim/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: yfinance
Requires-Dist: psutil
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# StockSim

**Monte Carlo Stock & Crypto Price Simulation Tool**

StockSim is a Python command-line tool for estimating the probability of gain for stocks, cryptocurrencies, or indices using Monte Carlo simulation and real historical data.

---

## Features

- Simulate future price paths for stocks, crypto, or indices
- Uses real historical data via [yfinance](https://github.com/ranaroussi/yfinance)
- Multiprocessing for fast simulations
- Command-line interface
- Logging to file and console

---

## Requirements

- Python 3.7–3.12 (not compatible with Python 3.13)
- See `requirements.txt` for required packages

---

## Installation

### From PyPI (recommended)

```sh
pip install stocksim
```

### From source

```sh
git clone https://github.com/ElementalPublishing/StockSim.git
cd StockSim
pip install -e .
```

---

## Usage

After installation, run from the command line:

```sh
stocksim
```

Or, if running from source:

```sh
python -m stocksim.main
```

---

## Command-Line Options

You can run StockSim with the following options:

- `--symbol`  
  Ticker symbol (e.g., `BTC-USD`, `ETH-USD`, `AAPL`, `SPX:IND`, `EURUSD:CUR`)

- `--years`  
  Investment period in years (e.g., `1`)

- `--simsize`  
  Simulation size: `small`, `medium`, or `large`

**Examples:**

```sh
stocksim --symbol BTC-USD --years 5 --simsize large
stocksim --symbol AAPL --years 3 --simsize medium
```

If you omit any option, the program will prompt you for input interactively.

---

## Build Windows Executable (Optional)

To build a Windows executable with your custom icon:

```sh
pyinstaller --icon=shaggy.ico --name=StockSim stocksim/main.py
```

- The EXE will be in the `dist` folder as `StockSim.exe`.

---

## Notes

- Compatible with Python 3.7–3.12, PyInstaller 5.13.2, and setuptools <80 (tested with 79.0.1).
- Log files are saved in the `logs` folder, with a new file for each run.
- For issues or feature requests, please use the [GitHub Issue Tracker](https://github.com/ElementalPublishing/StockSim/issues).

---

## License

This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
