Skip to main content

Python module to get kernel information via OS specific CLI commands

Project description

PyTradingBot

PyTradingBot is a python based trading bot API.

Python

Platform

pypi

Pypi Pypi-format Pypi-status

Summary

PyTradingBot is a python based trading bot API based on FinViz screener fields, and Yahoo finance.

Installation

pip install PyTradingBot

Usage

Initiate - IDE

from pytradingbot.server import start

if __name__ == '__main__':
    start()

Initiate - CLI

pytradingbot start

Use pytradingbot --help for usage instructions.

Containerized

Build

docker build -t pytradingbot .

Run

docker run --name pytradingbot -p 5005:5005 -e PORT=5005 pytradingbot

Environment Variables

All environment variables are optional.

API basics

  • PORT: API port. Defaults to 8080
  • LOG_LEVEL: Log level for the API server. Defaults to DEBUG
  • SCAN_COOLDOWN_SECONDS: Cooldown time before requesting another scan. Defaults to 60

Authentication

  • USERNAME: Username to protect the server with authentication.
  • PASSWORD: Password to protect the server with authentication.

Notification setup

  • TELEGRAM_BOT_TOKEN: Telegram bot token to notify the user.
  • TELEGRAM_CHAT_IDS: Comma separated list of chat IDs to notify.

To get the chat ID, message the bot on Telegram and run the command:

curl -s "https://api.telegram.org/bot${BOT_TOKEN}/getUpdates" \
| jq '.result[].message.chat.id'

Background Scheduler

The API runs a background async scheduler that triggers scans automatically (EST) and stores each run in the existing sqlite DB.

Default schedule:

  • Pre-Market (04:00-09:30): every 15 minutes
  • Market Open (09:30-10:30): every 5 minutes
  • Mid Day (10:30-14:00): every 30 minutes
  • Power Hour (14:00-16:00): every 5 minutes
  • After Hours (16:00-20:00): once at 16:15

You can override these rules from the Dashboard Schedule tab, or through:

  • GET /schedule to read current/default config
  • POST /schedule to save overrides

Release Notes

Requirement

python -m pip install gitverse

Usage

gitverse-release reverse -f release_notes.rst -t 'Release Notes'

Linting

pre-commit will ensure linting

Requirement

python -m pip install pre-commit

Usage

pre-commit run --all-files

Pypi Package

pypi-module

https://pypi.org/project/PyTradingBot/

License & copyright

© Vignesh Rao

Licensed under the MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pytradingbot-0.1.0-py3-none-any.whl (48.1 kB view details)

Uploaded Python 3

File details

Details for the file pytradingbot-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pytradingbot-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 48.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for pytradingbot-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 90abf512d625b3ce3b34fb617c3d4d2da3465713bf7eb3a784c42431dc7c2a20
MD5 fb61cd8bb6e624efddfcaba58e775db2
BLAKE2b-256 ec082d00712f6f00af5f23f06665162f5daa592bed7d1716320f0ddd3afb8781

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page