diff --git a/README-FA.md b/README-FA.md new file mode 100644 index 0000000..0d260c4 --- /dev/null +++ b/README-FA.md @@ -0,0 +1,310 @@ +

پای استایل

+
+

+ نسخه + + وضیعت مستندات + + + وضیعت توسعه + + + مجوز: EPL-2.0 + + + Downloads + +

+ +> **PyStyle** یک کتابخانه پایتون برای ساخت زیباترین ظاهر TUI. +>
+> با الهام از **pyfade** و **pycenter**. +>
+> ساخته شده توسط [Billy](https://github.com/billythegoat356), [loTus01](https://github.com/loTus04), [BlueRed](https://github.com/CSM-BlueRed) و [Thecode764](https://github.com/Thecode764) + + + + +## نصب کنید + +```sh +pip3 install pystyle +``` +وضیعت: https://pepy.tech/project/pystyle + +# بخش هایی که در این مستند گفته شده. + + - رنگی کردن متن ها ✔️ + - رنگی کردن متن ها با افکت ✔️ + - انیمیشن ها ❌ + - افکت های متنی ✔️ + - متن در مرکز ✔️ + - ساخت بنر ✔️ + - ساخت باکس ✔️ + - نشان دادن و پنهان کردن نشان گر ماوس ✔️ + - فانکشن ها سیستمی ✔️ + +
+ +## رنگی کردن متن ها + +

متن ها را به سادگی رنگی کنید.

+
+ +```python +from pystyle import Colors, Colorate +text = "Hello world!" +print(Colors.blue + text) +# یا از مثال زیر استفاده کنید +print(Colorate.Color(Colors.blue, text, True)) +``` + +
+ +`Colors.blue` = رنگ
+`text` = متنی که باید رنگی شود
+`True` = رنگ آمیزی را پس از پایان پایان دهید (در غیر این صورت چاپ کاراکترها در رنگ مشخص شده ادامه می یابد) + +
+ +در حال حاضر فانکشن های زیر وجود دارد: + - Color (رنگی کردن یک متن رنگی) + - Error (ساخت افکت خطا) + + +
+ +## یک متن رنگی با افکت بسازید! + +

یک متن رنگی با افکت بسازید

+
+ +```python +from pystyle import Colors, Colorate +print(Colorate.Horizontal(Colors.yellow_to_red, "Hello, Welcome to Pystyle.", 1)) +``` + +
+ +`Colors.yellow_to_red` = رنگ
+`Colorate.Vertical` = نوع
+`1` = شدت (پیش‌فرض=1) + +
+ +در حال حاضر افکت های زیر وجود دارد: + - Vertical + - Horizontal + - Diagonal + - DiagonalBackwards + +
+ +## ساخت یک متن با افکت های تایپی + +
+ +برای نوشتن یک متن با افکت های تایپی از `pystyle.Write` استفاده کنید. + +```python +from pystyle import Write, Colors + +name = Write.Input("Enter your name -> ", Colors.red_to_purple, interval=0.0025) +Write.Print(f"Nice to meet you, {name}!", Colors.blue_to_green, interval=0.05) +``` +
+ + +۲ فانکشن وجود دارد:
+ + +`Write.Print`: نمایش یک متن با افکت
+`Write.Input`: مثل همان `Write.Input` فقط به جای نوشتن ورودی میگیرد
+ + +
+ + +۶ آرگومان وجود دارد:
+ + +`text`: متنی که باید نوشته شود
+`color`: رنگی که برای متن میخواهید
+`interval`: فاصله نوشتن هر کلمه
+`hide_cursor`: پنهان کردن نشان گر ماوس
+`end`: رنگ انتهایی، پیش فرض سفید است
+`input_color` (فقط برای `Write.Input`): برای رنگ ورودی استفاده میشود
+ + +
+
+ + +## قرار دادن متن در وسط صفحه + +
+

یک متن را در مرکز صفحه قرار دهید!

+ +```python +from pystyle import Center +print(Center.XCenter("Hello, Welcome to Pystyle.")) +``` +
+

خروجی

+
+ +``` + Hello, Welcome to Pystyle. +``` + + +
+ +در حال حاضر حالت های زیر وجود دارد: + - Center (بنر/متن را در هر دو محور وسط قرار دهید) + - XCenter (بنر/متن را روی محور X وسط قرار دهید) + - YCenter (بنر/متن را روی محور Y وسط قرار دهید) + +

+ +## بنر اضافه کنید. +

به هر چیزی یک بنر اضافه کنید.

+ + +```python +from pystyle import Add +banner1 = ''' + .--. + .'_\/_'. + '. /\ .' + "||" + || /\ + /\ ||//\) + (/\\||/ +____\||/____''' + +text = "This is a beautiful banner\nmade with pystyle" + +print(Add.Add(banner1, text, 4)) +``` + +خروجی: + +``` + .--. + .'_\/_'. + '. /\ .' + "||" This is a beautiful banner + || /\ made with pystyle + /\ ||//\) + (/\||/ +____\||/____ +``` +
+ +`banner1` = بنر اول
+`text` = بنر دوم
+`4` = خطوط خالی قبل از افزودن کوچکترین بنر به بزرگترین بنر (پیش فرض = 0). برای وسط روی `True` تنظیم کنید
+ +## ساختن باکس! +

یک باکس زیبا بسازید!

+
+ +```python +from pystyle import Box +print(Box.Lines("Hello, Welcome to Pystyle.")) +print(Box.DoubleCube("Hello, Welcome to Pystyle.")) +``` + +خروجی: + +``` +─══════════════════════════☆☆══════════════════════════─ + Hello, Welcome to Pystyle. +─══════════════════════════☆☆══════════════════════════─ +╔════════════════════════════╗ +║ Hello, Welcome to Pystyle. ║ +╚════════════════════════════╝ +``` + +در حال حاضر این چند نوع وجود دارد: + - Lines + - SimpleCube + - DoubleCube + +## ماوس +ماوس را نشان دهید! + +```python +from pystyle import Cursor + +Cursor.ShowCursor() +``` + +ماوس را پنهان کنید! + +```python +from pystyle import Cursor + +Cursor.HideCursor() +``` + +## فانکشن های سیستمی +### با یک کد بررسی کنید ترمینال شما از رنگ پشتیبانی میکند؟ +```python +from pystyle import System + +System.Init() +``` +### صفحه ترمینال خود را تمیز کنید +```python +from pystyle import System + +System.Clear() +``` +### عنوان ترمینال خود را عوض کنید +```python +from pystyle import System + +System.Title("The title") +``` +**نکته: این قابلیت فقط در سیستم عامل ویندوز کار میکند** +### اندازه ترمینال خود را تغییر دهید + +**نکته** این قابلیت فقط در سیستم عامل ویندوز کار میکند + +```python +from pystyle import System + +System.Size(12,12) +``` +### یک کامند ترمینال را اجرا کنید +```python +from pystyle import System + +System.Command("echo hello") +``` + +
+
+ +## 👤 نویسندگان + +👤 گیت هاب: [@**billythegoat356**](https://github.com/billythegoat356)
+👤 گیت هاب: [@**loTus01**](https://github.com/loTus04)
+👤 گیت هاب: [@**BlueRed**](https://github.com/CSM-BlueRed)
+👤 گیت هاب (ترجمه کننده): [@**Thecode764**](https://github.com/Thecode764)
+ + +## 🤝 به توسعه کمک کنید + +توسعه دهنده های عزیز, اگر باگی دیدید گزارش دهید اگر میخواهید قابلیتی اضافه شود گزارش دهید!
این صفحه را برای اطلاعات بیشتر چک کنید + +[صفحه نظر ها و انتقادات](https://github.com/billythegoat356/pystyle/issues). + +## ❤ علاقه خود را به این پروژه نشان دهید + +به این پروژه یک ستاره بدهید اگر این پروژه به شما کمک کرده است. + + +*** diff --git a/README.md b/README.md index 8710098..6d5d1e5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

PyStyle


- Version + Version Documentation @@ -20,7 +20,7 @@ >
> Inspired by **pyfade** and **pycenter**, >
-> Developped by [Billy](https://github.com/billythegoat356), [loTus01](https://github.com/loTus04), and [BlueRed](https://github.com/CSM-BlueRed) +> Developped by [Billy](https://github.com/billythegoat356), [loTus01](https://github.com/loTus04), [BlueRed](https://github.com/CSM-BlueRed) and [Thecode764](https://github.com/Thecode764) @@ -293,6 +293,7 @@ System.Command("echo hello") 👤 GitHub: [@**billythegoat356**](https://github.com/billythegoat356)
👤 GitHub: [@**loTus01**](https://github.com/loTus04)
👤 GitHub: [@**BlueRed**](https://github.com/CSM-BlueRed)
+👤 GitHub: [@**Thecode764**](https://github.com/Thecode764)
## 🤝 Contributing @@ -304,3 +305,5 @@ Give a ⭐️ if this project helped you! *** +## Translations +[Persian](./README-FA.md) \ No newline at end of file