Skip to content

Commit

Permalink
#8 changelogs and readmes were updated about replacement default repo…
Browse files Browse the repository at this point in the history 
…rt filename from `report.md` to `deals.md`.
  • Loading branch information
@Tim55667757
Tim55667757 committed Aug 10, 2022
1 parent 85ce60a commit 29eaf99
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
##### Улучшения

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

##### Баг-фиксы
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG_EN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
##### 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.
* [#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. Changed default report filename from `report.md` to `deals.md`.
* [В работе] [#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.

##### Bug fixes
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README_EN.md#Usage-examp
`--no-cancelled` информация об отменённых операциях
не будет отображаться в отчёте по сделкам. Также можно
задать ключ `--output`, чтобы сохранить сделки в файл,
по умолчанию: `report.md`.
по умолчанию: `deals.md`.
--trade [TRADE [TRADE ...]]
Команда: универсальный способ, чтобы открыть сделку "по рынку"
для инструмента, заданного тикером или FIGI. Можно указать
Expand Down Expand Up @@ -996,7 +996,7 @@ TKSBrokerAPI.py L:3138 DEBUG [2022-08-10 22:06:27,154] TKSBrokerAPI module

Вместо начальной даты можно указать отрицательное число — количество предыдущих дней от текущей даты (`--deals -1`, `-d -2`, `-d -3`, ...), тогда конечную дату указывать не нужно. Также вместо начальной даты можно указать одно из ключевых слов: `today`, `yesterday` (-1 день), `week` (-7 дней), `month` (-30 дней), `year` (-365 дней). Во всех этих случаях будет выдан отчёт за указанное количество предыдущих дней и вплоть до сегодняшнего числа и текущего времени.

Дополнительно можно указать ключ `--output` для указания файла, куда сохранить отчёт по операциям в формате Markdown (по умолчанию `report.md` в текущей рабочей директории).
Дополнительно можно указать ключ `--output` для указания файла, куда сохранить отчёт по операциям в формате Markdown (по умолчанию `deals.md` в текущей рабочей директории).

<details>
<summary>Команда для получения отчёта по операциям между двумя указанными датами</summary>
Expand Down Expand Up @@ -1193,7 +1193,7 @@ TKSBrokerAPI.py L:1972 INFO [2022-07-28 18:29:15,026] # Client's operatio
| 2022-07-25 08:25:59 | TCS00A103X66 | POSI | Shares | — | -1.17 rub | √ Executed | Operation fee deduction
| 2022-07-25 08:25:58 | TCS00A103X66 | POSI | Shares | 5 | +4676.00 rub | √ Executed | Sell securities
TKSBrokerAPI.py L:1978 INFO [2022-07-28 18:29:15,032] History of a client's operations are saved to file: [report.md]
TKSBrokerAPI.py L:1978 INFO [2022-07-28 18:29:15,032] History of a client's operations are saved to file: [deals.md]
```

</details>
Expand Down Expand Up @@ -1275,7 +1275,7 @@ TKSBrokerAPI.py L:1972 INFO [2022-07-28 18:29:59,035] # Client's operatio
| 2022-07-21 17:11:30 | BBG00JN4FXG8 | SLDB | Shares | — | -0.01 usd | √ Executed | Operation fee deduction
| 2022-07-21 17:11:29 | BBG00JN4FXG8 | SLDB | Shares | 1 | -0.74 usd | √ Executed | Buy securities
TKSBrokerAPI.py L:1978 INFO [2022-07-28 18:29:59,045] History of a client's operations are saved to file: [report.md]
TKSBrokerAPI.py L:1978 INFO [2022-07-28 18:29:59,045] History of a client's operations are saved to file: [deals.md]
```

</details>
Expand Down
8 changes: 4 additions & 4 deletions README_EN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ options:
`--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`.
to file, default: `deals.md`.
--trade [TRADE [TRADE ...]]
Action: universal action to open market position for
defined ticker or FIGI. You must specify 1-5
Expand Down Expand Up @@ -996,7 +996,7 @@ The key `--deals` (`-d`) is used, after which you need to specify two dates: the

Instead of the start date, you can specify a negative number — the number of previous days from the current date (`--deals -1`, `-d -2`, `-d -3`, ...), then you do not need to specify the end date. Also, instead of the start date, you can specify one of the keywords: `today`, `yesterday` (-1 day), `week` (-7 days), `month` (-30 days), `year` (-365 days) . In all these cases, a report will be issued for the specified number of previous days up to today and the current time.

Additionally, you can specify the `--output` key to specify the file where to save the report on deals in Markdown format (by default, `report.md` in the current working directory).
Additionally, you can specify the `--output` key to specify the file where to save the report on deals in Markdown format (by default, `deals.md` in the current working directory).

<details>
<summary>Command to get a report on operations between two specified dates</summary>
Expand Down Expand Up @@ -1193,7 +1193,7 @@ TKSBrokerAPI.py L:1972 INFO [2022-07-28 18:29:15,026] # Client's operatio
| 2022-07-25 08:25:59 | TCS00A103X66 | POSI | Shares | — | -1.17 rub | √ Executed | Operation fee deduction
| 2022-07-25 08:25:58 | TCS00A103X66 | POSI | Shares | 5 | +4676.00 rub | √ Executed | Sell securities
TKSBrokerAPI.py L:1978 INFO [2022-07-28 18:29:15,032] History of a client's operations are saved to file: [report.md]
TKSBrokerAPI.py L:1978 INFO [2022-07-28 18:29:15,032] History of a client's operations are saved to file: [deals.md]
```

</details>
Expand Down Expand Up @@ -1275,7 +1275,7 @@ TKSBrokerAPI.py L:1972 INFO [2022-07-28 18:29:59,035] # Client's operatio
| 2022-07-21 17:11:30 | BBG00JN4FXG8 | SLDB | Shares | — | -0.01 usd | √ Executed | Operation fee deduction
| 2022-07-21 17:11:29 | BBG00JN4FXG8 | SLDB | Shares | 1 | -0.74 usd | √ Executed | Buy securities
TKSBrokerAPI.py L:1978 INFO [2022-07-28 18:29:59,045] History of a client's operations are saved to file: [report.md]
TKSBrokerAPI.py L:1978 INFO [2022-07-28 18:29:59,045] History of a client's operations are saved to file: [deals.md]
```

</details>
Expand Down

0 comments on commit 29eaf99

Please sign in to comment.