Skip to content
This repository was archived by the owner on Jan 13, 2024. It is now read-only.

Commit d920537

Browse files
author
DirectiveAthena
committed
Feature: Revamped README and docu for v3.1.1
1 parent b422443 commit d920537

File tree

8 files changed

+660
-89
lines changed

8 files changed

+660
-89
lines changed

Docu/Examples.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# AthenaColor Examples
2+
3+
## Nested Example:
4+
Copy directly
5+
```python
6+
from AthenaColor import (
7+
ForeNest,
8+
BackNest,
9+
StyleNest
10+
)
11+
12+
pre_formated = lambda t_: ForeNest.SkyBlue(StyleNest.Italic(BackNest.MidnightBlue(t_) ))
13+
14+
text = ForeNest.GoldenRod(
15+
StyleNest.Italic("Hello there!"),
16+
ForeNest.PaleGoldenRod ("This is an example of",StyleNest.Bold("NESTED"),"styling"),
17+
"Here we have some Golden rod again",
18+
BackNest.DarkViolet("No matter the makeup, everything is closed correctly"),
19+
pre_formated("The style of this part was preformatted"),
20+
sep="\n"
21+
)
22+
23+
print(text)
24+
```
25+
26+
Or find the exact function:
27+
```python
28+
from AthenaColor.Help import example_nested
29+
example_nested()
30+
```
31+
32+
---
33+
## Inline Example:
34+
35+
Copy directly
36+
```python
37+
from AthenaColor import (
38+
Fore,
39+
Back,
40+
Style,
41+
)
42+
pre_formated = lambda t_: f"{Fore.SkyBlue}{Style.Italic}{Back.MidnightBlue}{t_}{Style.NoForeground}{Style.NoItalic}{Style.NoBackground}"
43+
44+
text = \
45+
f"""{Fore.GoldenRod}{Style.Italic}Hello there!{Style.NoItalic}{Style.NoForeground}
46+
{Fore.PaleGoldenRod}This is an example of {Style.Bold}INLINE{Style.NoBold} styling{Style.NoForeground}
47+
{Fore.GoldenRod}Here we have some Golden rod again{Style.NoForeground},
48+
{Back.DarkViolet}{Fore.GoldenRod}Here we have to redefined colors and worry about resets{Style.NoForeground}{Style.NoBackground}
49+
{pre_formated("The style of this part was preformatted")}
50+
"""
51+
52+
print(text)
53+
```
54+
55+
Or find the exact function:
56+
```python
57+
from AthenaColor.Help import example_inline
58+
example_inline()
59+
```
60+
61+
---
62+
## custom RGB Example:
63+
Copy directly
64+
```python
65+
from AthenaColor import (
66+
ForeNest,
67+
BackNest,
68+
rgb
69+
)
70+
71+
color1 = rgb(r=86, g=54, b=251)
72+
color2 = rgb(214,124,61)
73+
74+
text = ForeNest.custom(BackNest.custom("This is a custom color",color=color2),color=color1)
75+
76+
print(text)
77+
```
78+
79+
Or find the exact function:
80+
```python
81+
from AthenaColor.Help import example_rgb
82+
example_rgb()
83+
```

Docu/Home.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# - AthenaColor -
2+
[![pypi](https://img.shields.io/pypi/v/AthenaColor)](https://pypi.org/project/AthenaColor/) [![GitHub license](https://img.shields.io/github/license/DirectiveAthena/VerSC-AthenaColor)](https://github.com/DirectiveAthena/VerSC-AthenaColor/blob/master/LICENSE) [![Discord](https://img.shields.io/discord/814599159926620160?color=maroon)](https://discord.gg/6JcDbhXkCH)
3+
4+
5+
<img height="128" src="https://github.com/DirectiveAthena/VSC-AthenaColor/blob/master/Resources/AthenaColor.png?raw=true" width="128"/>
6+
7+
A *No Dependency* python package for displaying the full spectrum of RGB colors in the Console.
8+
9+
---
10+
## Details and features
11+
- *Nested* and *Inline* options to print Style and Color makeup to the Console
12+
- 140 predefined extended HTML colors, see [here](https://github.com/DirectiveAthena/VerSC-AthenaColor/wiki/Predefined-Colors) for the full list
13+
- By using the `rgb` object, you have access to print any color you want
14+
15+
---
16+
## Content and Examples
17+
For examples on how to use the package, go to [the wiki examples](https://github.com/DirectiveAthena/VerSC-AthenaColor/wiki/Examples) on the Github Repo.
18+
19+
To immediately see what the package can do, run the package itself (will call the `__main__.py` file in the package):
20+
21+
```console
22+
python -m AthenaColor
23+
```
24+
25+
The following image is a print out of how the code above should print out:
26+
(The actual list of style Colors and makeup goes on for all 140 colors)
27+
28+
<img src="https://github.com/DirectiveAthena/VerSC-AthenaColor/blob/master/Resources/PyCharmOutput.png?raw=true"/>
29+
30+
---
31+
## Install
32+
To install the package in your Python environment
33+
34+
```console
35+
pip install AthenaColor
36+
```
37+
38+
---
39+
40+
## Links
41+
Project files can be found at:
42+
- [GitHub Repo](https://github.com/DirectiveAthena/VSC-AthenaColor)
43+
- [Pypi link](https://pypi.org/project/AthenaColor/)
44+
45+
---
46+
47+
## Disclaimer
48+
With *No Dependency*, the standard library is not counted as a dependency
49+
50+
---
51+
Made By Andreas Sas, 2022

0 commit comments

Comments
 (0)