Metadata-Version: 2.1
Name: colorfy-py
Version: 0.1.0
Summary: Library for text formatting in Unix-based systems
Author-email: CelestialEcho <borya.mishchenko2009@example.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
        1. Definitions.
        
           "License" shall mean the terms and conditions for use, reproduction, and
           distribution as defined by Sections 1 through 9 of this document.
        
           "Licensor" shall mean the copyright owner or entity authorized by the
           copyright owner that is granting the License.
        
           "Legal Entity" shall mean the union of the acting entity and all other
           entities that control, are controlled by, or are under common control with
           that entity. For the purposes of this definition, "control" means (i) the
           power, direct or indirect, to cause the direction or management of such
           entity, whether by contract or otherwise, or (ii) ownership of fifty percent
           (50%) or more of the outstanding shares, or (iii) beneficial ownership of
           such entity.
        
           "You" (or "Your") shall mean an individual or Legal Entity exercising
           permissions granted by this License.
        
           "Source" form shall mean the preferred form for making modifications,
           including but not limited to software source code, documentation source, and
           configuration files.
        
           "Object" form shall mean any form resulting from mechanical transformation or
           translation of a Source form, including but not limited to compiled object
           code, generated documentation, and conversions to other media types.
        
           "Work" shall mean the work of authorship, whether in Source or Object form,
           made available under the License, as indicated by a copyright notice that is
           included in or attached to the work (an example is provided in the Appendix
           below).
        
           "Derivative Works" shall mean any work, whether in Source or Object form,
           that is based on (or derived from) the Work and for which the editorial
           revisions, annotations, elaborations, or other modifications represent, as a
           whole, an original work of authorship. For the purposes of this License,
           Derivative Works shall not include works that remain separable from, or
           merely link (or bind by name) to the interfaces of, the Work and Derivative
           Works thereof.
        
           "Contribution" shall mean any work of authorship, including the original
           version of the Work and any modifications or additions to that Work or
           Derivative Works thereof, that is intentionally submitted to Licensor for
           inclusion in the Work by the copyright owner or by an individual or Legal
           Entity authorized to submit on behalf of the copyright owner. For the
           purposes of this definition, "submitted" means any form of electronic,
           verbal, or written communication sent to the Licensor or its
           representatives, including but not limited to communication on electronic
           mailing lists, source code control systems, and issue tracking systems that
           are managed by, or on behalf of, the Licensor for the purpose of discussing
           and improving the Work, but excluding communication that is conspicuously
           marked or otherwise designated in writing by the copyright owner as "Not a
           Contribution."
        
           "Contributor" shall mean Licensor and any individual or Legal Entity on
           behalf of whom a Contribution has been received by Licensor and subsequently
           incorporated within the Work.
        
        2. Grant of Copyright License. Subject to the terms and conditions of this
           License, each Contributor hereby grants to You a perpetual, worldwide,
           non-exclusive, no-charge, royalty-free, irrevocable copyright license to
           reproduce, prepare Derivative Works of, publicly display, publicly perform,
           sublicense, and distribute the Work and such Derivative Works in Source or
           Object form.
        
        3. Grant of Patent License. Subject to the terms and conditions of this
           License, each Contributor hereby grants to You a perpetual, worldwide,
           non-exclusive, no-charge, royalty-free, irrevocable (except as stated in
           this section) patent license to make, have made, use, offer to sell, sell,
           import, and otherwise transfer the Work, where such license applies only to
           those patent claims licensable by such Contributor that are necessarily
           infringed by their Contribution(s) alone or by combination of their
           Contribution(s) with the Work to which such Contribution(s) was submitted.
           If You institute patent litigation against any entity (including a
           cross-claim or counterclaim in a lawsuit) alleging that the Work or a
           Contribution incorporated within the Work constitutes direct or contributory
           patent infringement, then any patent licenses granted to You under this
           License for that Work shall terminate as of the date such litigation is
           filed.
        
        4. Redistribution. You may reproduce and distribute copies of the Work or
           Derivative Works thereof in any medium, with or without modifications, and
           in Source or Object form, provided that You meet the following conditions:
        
           (a) You must give any other recipients of the Work or Derivative Works a
               copy of this License; and
        
           (b) You must cause any modified files to carry prominent notices stating
               that You changed the files; and
        
           (c) You must retain, in the Source form of any Derivative Works that You
               distribute, all copyright, patent, trademark, and attribution notices
               from the Source form of the Work, excluding those notices that do not
               pertain to any part of the Derivative Works; and
        
           (d) If the Work includes a "NOTICE" text file as part of its distribution,
               then any Derivative Works that You distribute must include a readable
               copy of the attribution notices contained within such NOTICE file,
               excluding those notices that do not pertain to any part of the
               Derivative Works, in at least one of the following places: within a
               NOTICE text file distributed as part of the Derivative Works; within the
               Source form or documentation, if provided along with the Derivative
               Works; or, within a display generated by the Derivative Works, if and
               wherever such third-party notices normally appear. The contents of the
               NOTICE file are for informational purposes only and do not modify the
               License. You may add Your own attribution notices within Derivative
               Works that You distribute, alongside or as an addendum to the NOTICE
               text from the Work, provided that such additional attribution notices
               cannot be construed as modifying the License.
        
           You may add Your own copyright statement to Your modifications and may
           provide additional or different license terms and conditions for use,
           reproduction, or distribution of Your modifications, or for any such
           Derivative Works as a whole, provided Your use, reproduction, and
           distribution of the Work otherwise complies with the conditions stated in
           this License.
        
        5. Submission of Contributions. Unless You explicitly state otherwise, any
           Contribution intentionally submitted for inclusion in the Work by You to the
           Licensor shall be under the terms and conditions of this License, without
           any additional terms or conditions. Notwithstanding the above, nothing
           herein shall supersede or modify the terms of any separate license agreement
           you may have executed with Licensor regarding such Contributions.
        
        6. Trademarks. This License does not grant permission to use the trade names,
           trademarks, service marks, or product names of the Licensor, except as
           required for describing the origin of the Work and reproducing the content
           of the NOTICE file.
        
        7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
           writing, Licensor provides the Work (and each Contributor provides its
           Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
           KIND, either express or implied, including, without limitation, any
           warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or
           FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining
           the appropriateness of using or redistributing the Work and assume any risks
           associated with Your exercise of permissions under this License.
        
        8. Limitation of Liability. In no event and under no legal theory, whether in
           tort (including negligence), contract, or otherwise, unless required by
           applicable law (such as deliberate and grossly negligent acts) or agreed to
           in writing, shall any Contributor be liable to You for damages, including
           any direct, indirect, special, incidental, or consequential damages of any
           character arising as a result of this License or out of the use or inability
           to use the Work (including but not limited to damages for loss of goodwill,
           work stoppage, computer failure or malfunction, or any and all other
           commercial damages or losses), even if such Contributor has been advised of
           the possibility of such damages.
        
        9. Accepting Warranty or Additional Liability. While redistributing the Work
           or Derivative Works thereof, You may choose to offer, and charge a fee for,
           acceptance of support, warranty, indemnity, or other liability obligations
           and/or rights consistent with this License. However, in accepting such
           obligations, You may act only on Your own behalf and on Your sole
           responsibility, not on behalf of any other Contributor, and only if You
           agree to indemnify, defend, and hold each Contributor harmless for any
           liability incurred by, or claims asserted against, such Contributor by
           reason of your accepting any such warranty or additional liability.
        
        END OF TERMS AND CONDITIONS
Keywords: text-formatting,colors,Terminal,UNIX,coloring,colorama,Windows,color,Windows,formatting
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Text Processing
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

<div style="display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 20px;">
  <div style="display: flex; align-items: center; justify-content: center; gap: 20px;">
    <img 
      src="https://raw.githubusercontent.com/CelestialEcho/Colorfy/refs/heads/main/img/README/colorfy-logo_512x512.png" 
      alt="Colorfy Logo" 
      width="100" 
      style="position: relative; top: -10px; left: -10px;">
    <div>
      <h1 style="margin: 0;">Colorfy</h1>
      <div>
        <img src="https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54" alt="Python">
        <img src="https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black" alt="Linux">
        <img src="https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white" alt="Windows">
        <img src="https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0" alt="macOS">
        <img src="https://img.shields.io/badge/GitBook-%23000000.svg?style=for-the-badge&logo=gitbook&logoColor=white" alt="GitBook">
      </div>
    </div>
  </div>

  <div style="text-align: center;">
    <p><strong>Colorfy</strong> is a Python library for text-formatting in the console. You can use it on Unix-based systems, such as Linux and macOS, and on Windows.</p>
  </div>
</div>

---

## Installation

- **`pip install colorfy`**
- Download the file called **colorfy** from **include** folder.

---

## Warning
Warning: Some features could not be used in Windows, for example Windows does not support Stylist's features such as **BOLD** style (other probably work).
Info: To enable Stylist's features in **Windows Console** you have to **initialize colorfy**:
```python
from colorfy import Colorfy

Colorfy.init()
```

I have been using **Alpine Linux**, for showcase, so I **did not use** colorfy initialization


---

## Features

-   **Color support**: Use HEX color codes or RGBA tuples to apply colors to text.
-   **Pre-defined color palettes**: Includes basic colors and themed palettes (e.g., Catppuccin, Dracula and Solarized themes).
-   **Text styling**: Bold, italic, underline and strikethrough.


---


## Showcase
#### Custom colors

```python
from colorfy import Colorfy

#applying HEX color
some_color = Colorfy("#FF5733")
print(some_color.apply("Some color | example 1 " + some_color.hex))

#applying color using RGBA
another_color = Colorfy((255, 200, 133, 255))
print(another_color.apply("Some color | example 2 " + another_color.hex))
```
![img_example1](https://raw.githubusercontent.com/CelestialEcho/Colorfy/refs/heads/main/img/CODESNIP/img_example1.jpg)

#### Stylist

```python
from colorfy import Stylist, Palette

print(Stylist.BOLD + "Hello world" + Stylist.RESET)
print(Stylist.ITALIC + "Hello World" + Stylist.RESET)
print(Stylist.STRIKETHROUGHT + "Hello world" + Stylist.RESET)
print(Stylist.UNDLINE + "Hello World" + Stylist.RESET)
# I called it .SWAP cuz it swaps "apply" func's target layer to bg
print(Stylist.SWAP + Colorfy(Palette.RED).apply("Hello World") + Stylist.RESET)
```
![img_example2](https://raw.githubusercontent.com/CelestialEcho/Colorfy/refs/heads/main/img/CODESNIP/img_example2.jpg)

#### Palette

```python
from colorfy import Colorfy, Palette

print(Colorfy(Palette.Catppuccin.Latte.TEAL).apply("██ # TEAL"))
print(Colorfy(Palette.Catppuccin.Latte.SKY).apply("██ # SKY"))
print(Colorfy(Palette.Catppuccin.Latte.SAPPHIRE).apply("██ # SAPPHIRE"))
```
![img_example3](https://raw.githubusercontent.com/CelestialEcho/Colorfy/refs/heads/main/img/CODESNIP/img_example3.jpg)

---

## TODO
- [ ] Make color blending, so Alpha will not be useless argument
- [ ] Refactor some parts
- [ ] Add EMOJI class to print emojis in Console
- [ ] Add gradient functions same as in venaxyt/fade library, but also make it flexible, so you can create your own fade colors
- [ ] Add GitBook documentation

--- 
### P.S.
If you have any questions or ideas for this library, feel free to ask. My discord: **antisssocial_**




