Skip to content

Commit 96d8de8

Browse files
committed
#140 Refactor long_description format in setup.py.
Updated `long_description` to use a cleaner and more consistent multi-line string format. Improved readability and formatting for links to documentation in both English and Russian.
1 parent 2effa08 commit 96d8de8

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

setup.py

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,18 +56,16 @@
5656

5757
description="TKSBrokerAPI is a trading platform designed to automate and simplify trading scenarios. It integrates with the Tinkoff Invest API server using the REST protocol. The platform can be used in two flexible ways: Command-Line Interface (CLI) and Python Library. This feature-rich API is perfect for trading enthusiasts and professional developers creating advanced automation solutions.",
5858

59-
long_description="""![TKSBrokerAPI Logo](https://github.com/Tim55667757/TKSBrokerAPI/blob/develop/docs/media/TKSBrokerAPI-Logo.png?raw=true)
60-
61-
- 🇺🇸 📚 **Full documentation in English**
62-
[README_EN.md — develop](https://github.com/Tim55667757/TKSBrokerAPI/blob/develop/README_EN.md)
63-
64-
- 🇷🇺 📚 **Подробная документация на русском языке**
65-
[README.md — develop](https://github.com/Tim55667757/TKSBrokerAPI/blob/develop/README.md)
66-
67-
- ⚙ **TKSBrokerAPI**:
68-
- [tksbrokerapi/TKSBrokerAPI (EN) — master only](https://tim55667757.github.io/TKSBrokerAPI/docs/tksbrokerapi/TKSBrokerAPI.html)
69-
- [tksbrokerapi/TKSBrokerAPI (RU) — master only](https://tim55667757.github.io/TKSBrokerAPI/docs/tksbrokerapi/TKSBrokerAPI.html)
70-
""",
59+
long_description=(
60+
"![TKSBrokerAPI Logo]"
61+
"(https://github.com/Tim55667757/TKSBrokerAPI/blob/develop/docs/media/TKSBrokerAPI-Logo.png?raw=true)\n\n"
62+
"🇺🇸 📚 **English Documentation:**\n"
63+
"• Full README with examples: [README_EN.md](https://github.com/Tim55667757/TKSBrokerAPI/blob/develop/README_EN.md)\n"
64+
"• API Reference: [TKSBrokerAPI module docs](https://tim55667757.github.io/TKSBrokerAPI/docs/tksbrokerapi/TKSBrokerAPI.html)\n\n"
65+
"🇷🇺 📚 **Документация на русском:**\n"
66+
"• Подробное описание и примеры: [README.md](https://github.com/Tim55667757/TKSBrokerAPI/blob/develop/README.md)\n"
67+
"• Документация на модуль: [TKSBrokerAPI module docs](https://tim55667757.github.io/TKSBrokerAPI/docs/tksbrokerapi/TKSBrokerAPI.html)\n"
68+
),
7169

7270
long_description_content_type="text/markdown",
7371

0 commit comments

Comments
 (0)