firscript 1.0.0

A Python-based backtesting engine with a custom scripting system inspired by TradingView's Pine Script

FirScript

A modular scripting engine designed for algo trading. Write PineScript-like python code to define strategies, indicators, and libraries — then plug them into a clean, scriptable engine that does the orchestration for you.

---

💡 Why FirScript?

Building your own backtesting stack?
FirScript gives you a flexible core to run strategy and indicator code, manage dependencies, and control execution — without locking you into one opinionated interface.

• ✅ Write strategy logic as regular Python scripts
• ⚙️ Parse, register, and run strategies dynamically
• 🧹 Bring your own data, namespaces, and post-processors
• 🛠️ Easily embed into larger trading and backtesting systems or apps
• 🧪 Perfect for research, prototyping, and integration into custom trading platforms

---

Table of Contents

• Getting Started
• Namespaces, Your Way
• Who is FirScript for?
• What FirScript Isn't
• Contribute
• License

---

Getting Started

📦 Installation

pip install FirScript talipp pandas numpy

🚀 Quick Start

from FirScript import Engine

strategy_source = '''
def setup():
    global fast_length, slow_length
    fast_length = input.int("Fast MA Length", 10)
    slow_length = input.int("Slow MA Length", 20)

def process():
    if ta.crossover(ta.ema(data.all.close, fast_length), ta.ema(data.all.close, slow_length)):
        strategy.long()
'''

data = pd.DataFrame({
        'timestamp': pd.date_range('2025-01-01', periods=50),
        'open': [100 + 0.5*i + random.random() for i in range(50)],
        'close': [100 + 0.5*i + random.random() for i in range(50)],
        'high': [100 + 0.5*i + random.random() for i in range(50)],
        'low': [100 + 0.5*i + random.random() for i in range(50)],
        'volume': [100 + 0.5*i + random.random() for i in range(50)]
    })

engine = Engine(data, main_script_str=strategy_source)
results = engine.run()

print(results)

TADA - You just ran your first strategy!

---

💡 Examples

Want to see it in action? Explore these ready-to-run examples in the examples folder:

• Simple Strategy – A basic trading strategy to get you started.
• Simple Indicator – How to define and use a custom indicator.
• Simple Library – Create reusable components with a simple library.
• Importing Indicators Into Strategy – Combine indicators into your strategy logic.
• Using Libraries In Strategy – Integrate libraries directly into your strategies.
• Custom Namespace – Extend your functionality using custom namespaces.

---

🧠 Namespaces, Your Way

FirScript ships with default namespaces (ta, input, chart, color, data, strategy) — but you can register your own.

class MySignals:
    @staticmethod
    def crossover(fast, slow):
        return (fast > slow) & (fast.shift() < slow.shift())

registry.register("signals", MySignals())

Now your script can do:

if signals.crossover(ema_fast, ema_slow):
    strategy.long()

Check out the full implementation here.

---

🧹 Who is FirScript for?

• Build your own backtesting UI or cloud platform
• Dynamically load and run user-submitted strategies
• Combine with Pandas, Plotly, or any data science tool
• Use as a logic core for live or paper trading systems

---

🚫 What FirScript Isn't

• ❌ A charting library (use Plotly, Matplotlib, etc.)
• ❌ A full broker API or execution engine
• ❌ A replacement for full frameworks like Backtrader — FirScript is lean, modular, and pluggable

---

🤝 Contribute

We welcome issues, ideas, and PRs — especially if you're building on top of this engine.

Contributing Guide

📖 License

FirScript is licensed under a MIT license.