avin/
lib.rs

1/*****************************************************************************
2 * CREATED:     2023.07.23 15:06
3 * URL:         http://avin.info
4 * AUTHOR:      Alex Avin
5 * E-MAIL:      mr.alexavin@gmail.com
6 * LICENSE:     MIT
7 ****************************************************************************/
8
9//! # AVIN  -  Ars Vincere (лат. искусство побеждать)
10//! ```text
11//!                             Open source cross-platform trading system
12//!                                      __   _    _  ___  __   _
13//!                                     /__\   \  /    |   | \  |
14//!                                    |    |   \/    _|_  |  \_|
15//!
16//! ```
17//!
18//! # ru
19//! ## Начало работы (Getting start)
20//!
21//! Чтобы как то подступиться к работе с системой, рассмотрим элементарные
22//! примеры, как вообще работать с системой, и как писать свои стратегии.
23//!
24//! Для работы нужен тинькофф токен, аккаунт на Московской бирже,
25//! настроеный конфиг, биржевые данные. С этого и начнем.
26//!
27//! ### Тинькофф токен.
28//! Что такое токен, и как его выпустить, смотрите [официальную инструкцию
29//! Т-Банка](https://developer.tbank.ru/invest/intro/intro/token)
30//!
31//! ### MOEX аккаунт.
32//! Для загрузки данных с Московской биржы, там нужно зарегистрироваться.
33//! Регистрация бесплатная: <https://passport.moex.com/registration>
34//!
35//! С этой регистрацией доступны свечи и тики за сегодня. Остальные
36//! рыночные данные по платной подписке:
37//! <https://data.moex.com/products/algopack>
38//!
39//! ### Config
40//! Образец файла смотрите в репозатарии
41//! <https://github.com/arsvincere/avin/blob/master/res/config.toml>
42//!
43//! Все настройки пользователся задаются в нем. Отредактируйте его под себя
44//! (как минимум задайте пути к папке где вы будете работать, и папке с
45//! рыночными данными). В остальном можно использовать и дефолтный.
46//!
47//! Переместите файл в ~/.config/avin/config.toml
48//!
49//! ### Загрузка рыночных данных.
50//! На данный момент доступная загрузка рыночных данных только с Московской
51//! биржи. Сделана утилита с элементарным cli интерфейсом.
52//!
53//! Установка утилиты avin-data
54//! ```bash
55//! git clone --depth=1 https://github.com/arsvincere/avin.git
56//! cd avin
57//! make install
58//! ```
59//!
60//! Программа устанавливается в ~/.local/bin. Проверьте что этот путь
61//! добавлен в PATH. Если нет:
62//! ```bash
63//! export PATH=$HOME/.local/bin:$PATH
64//! ```
65//!
66//! Первое что нужно сделать - кэшировать информацию о доступных инструментах.
67//! ```bash
68//! avin-data cache
69//! ```
70//!
71//! Поиск инструмента:
72//! ```bash
73//! avin-data find -i "moex_share_sber"
74//! ```
75//!
76//! Загрузка всех имеющихся рыночных данных по инструменту:
77//! ```bash
78//! avin-data download -i "moex_share_sber"
79//! ```
80//!
81//! Посмотреть другие возможности программы:
82//! ```bash
83//! avin-data --help
84//! ```
85//!
86
87pub use avin_analyse as analyse;
88pub use avin_connect as connect;
89pub use avin_core as core;
90pub use avin_gui as gui;
91pub use avin_scanner as scanner;
92pub use avin_simulator as simulator;
93pub use avin_strategy as strategy;
94pub use avin_tester as tester;
95pub use avin_trader as trader;
96pub use avin_utils as utils;