ampyfin

(β˜… 427)

End-to-end ensemble trading framework that trains, backtests, and promotes validated strategies to live execution.

  • .dockerignore
  • .gitignore
  • .isort.cfg
  • .pre-commit-config.yaml
  • CODE_OF_CONDUCT.md
  • config.py
  • CONTRIBUTING.md
  • control.py
  • Dockerfile
  • MIT_LICENSE.txt
  • pyproject.toml
  • README.md
  • requirements-dev.txt
  • requirements.txt
  • setup.py

# Installation Guide

1. Get the code
git clone https://github.com/AmpyFin/ampyfin

Downloads the entire project code from GitHub to your computer.

cd ampyfin

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install <downloaded-wheel-file>.whl

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t ampyfin .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 ampyfin

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

pip install <downloaded-wheel-file>.whl

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation