Initial commit

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+skrphenix.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

@@ -0,0 +1,70 @@
+## Contributing to <u>pycolorise</u>
+
+First off, thanks for taking the time to contribute. It makes the library substantially better. :+1:
+
+The following is a set of guidelines for contributing to the repository. These are guidelines, not hard rules.
+
+<hr/>
+
+## Good Bug Reports
+
+#### Please be aware of the following things when filing bug reports.
+
+1. Don't open duplicate issues. Please search your issue to see if it has been asked already. Duplicate issues will be
+   closed.
+2. When filing a bug about exceptions or tracebacks, please include the _complete_ traceback. Without the complete
+   traceback the issue might be **unsolvable** and you will be asked to provide more information.
+3. Make sure to provide enough information to make the issue workable. The issue template will generally walk you
+   through the process, but they are enumerated here as well:
+    - A **summary** of your bug report. This is generally a quick sentence or two to describe the issue in human terms.
+    - Guidance on **how to reproduce the issue**. Ideally, this should have a small code sample that allows us to run
+      and see the issue for ourselves to debug. **Please make sure that the token is not displayed**. If you cannot
+      provide a code snippet, then let us know what the steps were, how often it happens, etc.
+    - Tell us **what you expected to happen**. That way we can meet that expectation.
+    - Tell us **what actually happens**. What ends up happening in reality? It's not helpful to say "it fails" or "it
+      doesn't work". Say _how_ it failed, do you get an exception? Does it hang? How are the expectations different from
+      reality?
+    - Tell us **information about your environment**. What version of **pycord-btns-menus** are you using? How was it
+      installed? What operating system are you running on? These are valuable questions and information that we use.
+
+If the bug report is missing this information then it'll take us longer to fix the issue. We will probably ask for
+clarification, and barring that if no response was given then the issue will be closed.
+
+Please try your best not to ask questions in our issue tracker. Most of them don't belong there unless they provide
+value to a larger audience.
+
+<hr/>
+
+## Submitting a Pull Request
+
+Submitting a pull request is fairly simple, just make sure it focuses on a single aspect and doesn't manage to have
+scope creep, and it's probably good to go. It would be incredibly lovely if the style is consistent to that found in the
+project. This project follows PEP-8 guidelines (mostly) with a column limit of 125.
+
+<hr/>
+
+### Licensing
+
+By submitting a pull request, you agree that:
+
+1. You hold the copyright on all submitted code inside said pull request;
+2. You agree to transfer all rights to the owner of this repository, and; 3) If you are found to be in fault with any of
+   the above, we shall not be held responsible in any way after the pull request has been merged.
+
+<hr/>
+
+# Contact Us
+
+You can get support/help/guidance from below social-media links
+
+- <a href="https://github.com/Modern-Realm">Home Page</a>
+- <a href="https://discord.gg/GVMWx5EaAN">Official Discord Server</a>
+
+<hr/>
+
+## Direct Links for <u>Contributors</u>
+
+- <a href="https://github.com/Modern-Realm/pycolorise/issues/new/choose">Open Issue</a>
+- <a href="https://github.com/Modern-Realm/pycolorise/pulls">Pull Requests</a>
+
+<hr/>

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,69 @@
+name: Bug
+description: File a bug report
+labels:
+  - unconfirmed bug
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before opening a bug report, please search for the behaviour in the existing issues. 
+        
+        ---
+        
+        Thank you for taking the time to file a bug report. To address this bug as fast as possible, we need some information.
+  - type: dropdown
+    id: location
+    attributes:
+      label: Project Location
+      description: Where is the project located?
+      options:
+        - pycolorise.colors
+        - pycolorise.ext
+        - pycolories.enums
+        - pycolorise.styles
+    validations:
+      required: true
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Bug description
+      description: What happened?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Minimal Reproducible Code
+      description: >
+        A short snippet of code that showcases the bug.
+      render: python
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: If applicable, provide relevant log output. No need for backticks here.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: Which steps do we need to take to reproduce this error?
+  - type: checkboxes
+    id: TC
+    attributes:
+      label: Checklist
+      description: Let's make sure you've properly done due dilligence when reporting this issue!
+      options:
+        - label: I have searched the open issues for duplicates.
+          required: true
+        - label: I have shown the entire traceback, if possible.
+          required: true
+        - label: I have removed my token from display, if visible.
+          required: true
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: If there is anything else to say, please do so here.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,50 @@
+name: Feature Request
+description: Suggest a feature for this library
+labels:
+  - feature request
+body:
+  - type: input
+    attributes:
+      label: Summary
+      description: >
+        A short summary of what your feature request is.
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      multiple: false
+      label: What is the feature request for?
+      options:
+        - pycolorise.colors
+        - pycolorise.ext
+        - pycolories.enums
+        - pycolorise.styles
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: The Purpose
+      description: >
+        What problem is your feature trying to solve?
+        What becomes easier or possible when this feature is implemented?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: The Ideal Solution
+      description: >
+        What is your ideal solution to the problem?
+        What would you like this feature to do?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: The Current Solution
+      description: >
+        What is the current solution to the problem, if any?
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: If there is anything else to say, please do so here.

.github/ISSUE_TEMPLATE/vulnerability_report.yml

@@ -0,0 +1,48 @@
+name: Vulnerability Report
+description: Report vulnerabilities
+labels:
+  - unconfirmed vulnerability
+assignees: skrphenix
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for taking the time to fill out a vulnerability report.
+        If you want real-time support, consider joining our Discord at https://discord.gg/GVMWx5EaAN instead.
+
+        Please note that this form is for vulnerability reports only!
+  - type: textarea
+    attributes:
+      label: Summary
+      description: A simple summary of your vulnerability report
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Reproduction Steps
+      description: >
+        What you did to make it happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Minimal Reproducible Code
+      description: >
+        A short snippet of code that showcases the vulnerability.
+      render: python
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      description: >
+        Let's make sure you've properly done due diligence when reporting this issue!
+      options:
+        - label: I have searched the open issues for duplicates.
+          required: true
+        - label: I have shown the entire steps to reproduce the vulnerability.
+          required: true
+        - label: I have removed my token from display, if visible.
+          required: true
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: If there is anything else to say, please do so here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+## Summary
+
+<!-- What is this pull request for? Does it fix any issues? -->
+
+## Checklist
+
+<!-- Put an x inside [ ] to check it, like so: [x] -->
+
+- [ ] If code changes were made then they have been tested.
+- [ ] I have updated the documentation to reflect the changes.
+- [ ] If `type: ignore` comments were used, a comment is also left explaining why
+- [ ] This PR fixes an issue.
+- [ ] This PR adds something new (e.g. new method or parameters).
+- [ ] This PR is a breaking change (e.g. methods or parameters removed/renamed)
+- [ ] This PR is **not** a code change (e.g, README, typehinting, examples, ...)