Skip to content

Commit

Permalink
#8 changelogs and readmes were updated about --no-cancelled key
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim55667757 committed Aug 10, 2022
1 parent 2101d3b commit 85ce60a
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@
##### Улучшения

* [#12](https://github.com/Tim55667757/TKSBrokerAPI/issues/12) В общую информацию о состоянии портфеля (ключ `--overview` или `-o`), добавлен раздел "Распределение портфеля по странам" ([пример](https://github.com/Tim55667757/TKSBrokerAPI#получить-текущий-портфель-пользователя-и-статистику-распределения-активов)).
* [#8](https://github.com/Tim55667757/TKSBrokerAPI/issues/8) Добавлен ключ `--no-cancelled` и переменная `showCancelled` в методе `Deals()`, чтобы регулировать отображение информации об отменённых операциях при использовании ключа `--deals` (или `-d`).
* [В работе] [#42](https://github.com/Tim55667757/TKSBrokerAPI/issues/42) Добавлен [пример](https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README.md#Пример-реализации-абстрактного-сценария) реализации абстрактного торгового сценария.
* [В работе] [#8](https://github.com/Tim55667757/TKSBrokerAPI/issues/8) Добавлен ключ `--no-cancelled`, чтобы не отображать информацию об отменённых операциях при использовании ключа `--deals` (или `-d`).

##### Баг-фиксы

Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@
##### Improvements

* [#12](https://github.com/Tim55667757/TKSBrokerAPI/issues/12) In the general information about the state of the portfolio (key `--overview` or `-o`), the section "Portfolio distribution by countries" has been added ([example](https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README_EN.md#Get-the-current-portfolio-and-asset-allocation-statistics)).
* [#8](https://github.com/Tim55667757/TKSBrokerAPI/issues/8) Added the `--no-cancelled` key and the `showCancelled` variable in the `Deals()` method to control shows canceled operations when using the `--deals` (or `-d`) key.
* [В работе] [#42](https://github.com/Tim55667757/TKSBrokerAPI/issues/42) [Example](https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README_EN.md#Abstract-scenario-implementation-example) with abstract trade scenario was added.
* [In progress] [#8](https://github.com/Tim55667757/TKSBrokerAPI/issues/8) Added the `--no-cancelled` key to not display information about canceled operations when using the `--deals` (or `-d`) key.

##### Bug fixes

Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,9 @@ https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README_EN.md#Usage-examp
`BBG006L8G4H1` для инструмента с тикером `YNDX`.
--depth DEPTH Параметр: число, показывающее "глубину биржевого стакана"
(Depth of Market, DOM), должно быть >=1, по умолчанию 1.
--no-cancelled Параметр: удалить информацию об отменённых операциях
из отчёта по сделкам, полученного с ключом `--deals`.
False по умолчанию.
--output OUTPUT Параметр: строка, которая заменяет стандартный путь вывода в файл
для некоторых команд. Если None, тогда используется стандартный путь.
--debug-level DEBUG_LEVEL, --verbosity DEBUG_LEVEL, -v DEBUG_LEVEL
Expand Down Expand Up @@ -373,7 +376,9 @@ https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README_EN.md#Usage-examp
параметр указывает на начальную дату: -1, -2, -3 дней назад.
Также можно использовать ключевики: `today`, `yesterday` (-1),
`week` (-7), `month` (-30) и `year` (-365). Формат дат должен
быть такой: `%Y-%m-%d`, например, 2020-02-03. Также можно
быть такой: `%Y-%m-%d`, например, 2020-02-03. С ключом
`--no-cancelled` информация об отменённых операциях
не будет отображаться в отчёте по сделкам. Также можно
задать ключ `--output`, чтобы сохранить сделки в файл,
по умолчанию: `report.md`.
--trade [TRADE [TRADE ...]]
Expand Down
13 changes: 9 additions & 4 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,9 @@ options:
`YNDX`).
--depth DEPTH Option: Depth of Market (DOM) can be >=1, 1 by
default.
--no-cancelled Option: remove information about cancelled operations
from the deals report by the `--deals` key. `False` by
default.
--output OUTPUT Option: replace default paths to output files for some
commands. If None then used default files.
--debug-level DEBUG_LEVEL, --verbosity DEBUG_LEVEL, -v DEBUG_LEVEL
Expand Down Expand Up @@ -368,14 +371,16 @@ options:
--overview, -o Action: show all open positions, orders and some
statistics. Also, you can define `--output` key to save
this information to file, default: `overview.md`.
--deals [DEALS [DEALS ...]], -d [DEALS [DEALS ...]]
--deals [DEALS ...], -d [DEALS ...]
Action: show all deals between two given dates. Start
day may be an integer number: -1, -2, -3 days ago.
Also, you can use keywords: `today`, `yesterday` (-1),
`week` (-7), `month` (-30) and `year` (-365). Dates
format must be: `%Y-%m-%d`, e.g. 2020-02-03. Also, you
can define `--output` key to save all deals to file,
default: `report.md`.
format must be: `%Y-%m-%d`, e.g. 2020-02-03. With
`--no-cancelled` key information about cancelled
operations will be removed from the deals report.
Also, you can define `--output` key to save all deals
to file, default: `report.md`.
--trade [TRADE [TRADE ...]]
Action: universal action to open market position for
defined ticker or FIGI. You must specify 1-5
Expand Down

0 comments on commit 85ce60a

Please sign in to comment.