UPDATED 05.27.2024

Author: johnbumgarner

CODE_OF_CONDUCT.md

@@ -1,6 +1,8 @@
-# Contributor Covenant Code of Conduct
+<h1 style="color:IndianRed;">Contributor Covenant Code of Conduct</h1>
 
-## Our Pledge
+---
+
+<h2 style="color:IndianRed;">Our Pledge</h2>
 
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
@@ -12,7 +14,7 @@ and orientation.
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
 
-## Our Standards
+<h2 style="color:IndianRed;">Our Standards</h2>
 
 Examples of behavior that contributes to a positive environment for our
 community include:
@@ -36,7 +38,7 @@ Examples of unacceptable behavior include:
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
-## Enforcement Responsibilities
+<h2 style="color:IndianRed;">Enforcement Responsibilities</h2>
 
 Community leaders are responsible for clarifying and enforcing our standards of
 acceptable behavior and will take appropriate and fair corrective action in
@@ -48,15 +50,15 @@ 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
+<h2 style="color:IndianRed;">Scope</h2>
 
 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
+<h2 style="color:IndianRed;">Enforcement</h2>
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
@@ -66,12 +68,12 @@ 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
+<h2 style="color:IndianRed;">Enforcement Guidelines</h2>
 
 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
+<h3 style="color:IndianRed;">1. Correction</h3>
 
 **Community Impact**: Use of inappropriate language or other behavior deemed
 unprofessional or unwelcome in the community.
@@ -80,7 +82,7 @@ unprofessional or unwelcome in the community.
 clarity around the nature of the violation and an explanation of why the
 behavior was inappropriate. A public apology may be requested.
 
-### 2. Warning
+<h3 style="color:IndianRed;">2. Warning</h3>
 
 **Community Impact**: A violation through a single incident or series
 of actions.
@@ -92,7 +94,7 @@ 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
+<h3 style="color:IndianRed;">3. Temporary Ban</h3>
 
 **Community Impact**: A serious violation of community standards, including
 sustained inappropriate behavior.
@@ -103,7 +105,7 @@ 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
+<h3 style="color:IndianRed;">4. Permanent Ban</h3>
 
 **Community Impact**: Demonstrating a pattern of violation of community
 standards, including sustained inappropriate behavior,  harassment of an
@@ -112,7 +114,7 @@ individual, or aggression toward or disparagement of classes of individuals.
 **Consequence**: A permanent ban from any sort of public interaction within
 the community.
 
-## Attribution
+<h2 style="color:IndianRed;">Attribution</h2>
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at

CONTRIBUTING.md

@@ -1,16 +1,15 @@
-## Contributing to Wordhoard
+<h1 style="color:IndianRed;">Contributing to Wordhoard</h1>
 
+___
 We're glad that you want to contribute to the Wordhoard project! This document will help answer common questions you may have during your first contribution or whether it is, such as:
 
-
 - Reporting a bug
 - Discussing the current state of the code
 - Submitting a fix
 - Proposing new features
 - Becoming a maintainer
 
-
-## Submitting Issues
+<h2 style="color:IndianRed;">Submitting Issues</h2>
 
 Not every contribution comes in the form of code. Submitting, confirming, and triaging issues is an important task for any project. 
 
@@ -28,8 +27,7 @@ Write bug or issue reports with detail, background, and sample code:
 - What actually happens
 - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
 
-
-## Pull Requests
+<h2 style="color:IndianRed;">Pull Requests</h2>
 
 Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
 
@@ -40,8 +38,7 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
 5. Make sure your code lints.
 6. Issue that pull request!
 
-
-## Reporting a Vulnerability
+<h2 style="color:IndianRed;">Reporting a Vulnerability</h2>
 
 If you have found a security vulnerability in *Wordhoard*, or a dependency use, please contact us on [Slack](https://wordhoardsupport.slack.com) or via email me at [Wordhoard project](mailto:wordhoardproject@gmail.com?subject=[GitHub]%20wordhoard%20project%20security%20issue).
 
@@ -52,7 +49,7 @@ will be created by the Member and you will be invited to explain the problem fur
 Please provide a [concise reproducible test case](http://sscce.org/) and describe what results you are seeing and what results you expect.
 
 
-## Developer Certification of Origin (DCO)
+<h2 style="color:IndianRed;">Developer Certification of Origin (DCO)</h2>
 
 Licensing is very important to open source projects. It helps ensure the software continues to be available under the terms that the author desired.
 
@@ -93,7 +90,9 @@ By making a contribution to this project, I certify that:
     involved.
 ```
 
-# DCO Sign-Off Methods
+<h1 style="color:IndianRed;">DCO Sign-Off Methods</h1>
+
+___
 
 The DCO requires a sign-off message in the following format appear on each commit in the pull request:
 
@@ -103,7 +102,7 @@ Signed-off-by: Super Coder <supercoder@somedomain.com>
 
 The DCO text can either be manually added to your commit body, or you can add either -s or --signoff to your usual git commit commands. If you are using the GitHub UI to make a change you can add the sign-off message directly to the commit message when creating the pull request. If you forget to add the sign-off you can also amend a previous commit with the sign-off by running git commit --amend -s. If you've pushed your changes to GitHub already you'll need to force push your branch after this with git push -f.
 
-## Wordhoard Obvious Fix Policy
+<h2 style="color:IndianRed;">Wordhoard Obvious Fix Policy</h2>
 
 Small contributions, such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted without signing the contribution for the DCO.
 

README.md

@@ -3,7 +3,7 @@
   <img src="https://github.com/johnbumgarner/wordhoard/blob/master/graphic/wordhoard_graphic.jpg"/>
 </p>
 
-# Overviews
+<h1 style="color:IndianRed;">Overviews</h1>
 
 ![PyPI](https://img.shields.io/pypi/v/wordhoard) &nbsp;
 ![License: MIT](https://img.shields.io/github/license/johnbumgarner/wordhoard)&nbsp;
@@ -13,7 +13,8 @@
 
 <!-- [![wordhoard](https://snyk.io/advisor/python/wordhoard/badge.svg)](https://snyk.io/advisor/python/wordhoard)&nbsp; -->
 
-# Primary Use Case
+<h1 style="color:IndianRed;">Primary Use Case</h1>
+
 <p align="justify"> 
 Textual analysis is a broad term for various research methodologies used to qualitatively describe, interpret and understand text data. These methodologies are mainly used in academic research to analyze content related to media and communication studies, popular culture, sociology, and philosophy. Textual analysis allows these researchers to quickly obtain relevant insights from unstructured data. All types of information can be gleaned from textual data, especially from social media posts or news articles. Some of this information includes the overall concept of the subtext, symbolism within the text, assumptions being made and potential relative value to a subject (e.g. data science). In some cases it is possible to deduce the relative historical and cultural context of a body of text using analysis techniques coupled with knowledge from different disciplines, like linguistics and semiotics.
 
@@ -22,7 +23,7 @@ Word frequency is the technique used in textual analysis to measure the frequenc
 <strong>WordHoard</strong> was designed to assist researchers performing textual analysis to build more comprehensive lists of antonyms, synonyms, hypernyms, hyponyms and homophones.
 </p>
 
-# Installation
+<h1 style="color:IndianRed;">Installation</h1>
 
 <p align="justify"> 
    Install the distribution via pip:
@@ -32,13 +33,13 @@ Word frequency is the technique used in textual analysis to measure the frequenc
 pip3 install wordhoard
 ```
 
-# General Package Utilization
+<h1 style="color:IndianRed;">General Package Utilization</h1>
 
 <p align="justify">
 Please reference the <a href="https://wordhoard.readthedocs.io/en/latest" target="_blank">WordHoard Documentation</a> for package usage guidance and parameters.
 </p>
 
-# Sources
+<h1 style="color:IndianRed;">Sources</h1>
 
 <p align="justify">
 This package is currently designed to query these online sources for antonyms, synonyms, hypernyms, hyponyms and definitions:
@@ -51,8 +52,8 @@ This package is currently designed to query these online sources for antonyms, s
 6. wordhippo.com
 7. wordnet.princeton.edu
 </p>
-  
-# Dependencies
+
+<h1 style="color:IndianRed;">Dependencies</h1>
 
 <p align="justify">
 This package has these core dependencies:
@@ -70,7 +71,7 @@ This package has these core dependencies:
 Additional details on this package's dependencies can be found <a href="https://wordhoard.readthedocs.io/en/latest/dependencies" target="_blank">here</a>.
 </p>
 
-# Development Roadmap
+<h1 style="color:IndianRed;">Development Roadmap</h1>
 
 <p align="justify">
 If you would like to contribute to the <strong>WordHoard</strong> project please read the <a href="https://wordhoard.readthedocs.io/en/latest/contributing" target="_blank">contributing guidelines</a>.
@@ -80,7 +81,7 @@ Items currently under development:
    - Adding part-of-speech filters in queries 
 </p>
 
-# Issues
+<h1 style="color:IndianRed;">Issues</h1>
 
 <p align="justify">
 This repository is actively maintained.  Feel free to open any issues related to bugs, coding errors, broken links or enhancements. 
@@ -89,17 +90,17 @@ You can also contact me at [John Bumgarner](mailto:wordhoardproject@gmail.com?su
 </p>
 
 
-# Sponsorship
-   
+<h1 style="color:IndianRed;">Sponsorship</h1>
+
 If you would like to contribute financially to the development and maintenance of the <strong>WordHoard</strong> project please read the <a href="https://github.com/johnbumgarner/wordhoard/blob/master/SPONSOR.md">sponsorship information</a>.
 
-# License
+<h1 style="color:IndianRed;">License</h1>
 
 <p align="justify">
 The MIT License (MIT).  Please see <a href="https://wordhoard.readthedocs.io/en/latest/license" target="_blank">License File</a> for more information.
 </p>
 
-# Author
+<h1 style="color:IndianRed;">Author</h1>
 
 <p align="justify">
   Copyright (c) 2020 John Bumgarner

SECURITY.md

@@ -1,6 +1,7 @@
-# Security Policy
+<h1 style="color:IndianRed;">Security Policy</h1>
 
-## Reporting a Vulnerability
+---
+<h2 style="color:IndianRed;">Reporting a Vulnerability</h2>
 
 If you have found a security vulnerability in *Wordhoard*, or a dependency use, please contact us on [Slack](https://wordhoardsupport.slack.com) or via email me at [Wordhoard project](mailto:wordhoardproject@gmail.com?subject=[GitHub]%20wordhoard%20project%20security%20issue).
 

SPONSOR.md

@@ -1,6 +1,8 @@
-# Sponsor Wordhoard
+<h1 style="color:IndianRed;">Sponsor Wordhoard</h1>
 
-## Overview
+---
+
+<h2 style="color:IndianRed;">Overview</h2>
 
 <p align="justify">
 
@@ -11,14 +13,14 @@ This document outlines the current methods to sponsor the <i>Wordhoard</i> proje
 please don't hesitate to reach out to me [here](mailto:wordhoardproject@gmail.com?subject=[GitHub]%20wordhoard%20project%20sponsorship%20request).
 </p>
 
-## Methods of Sponsorship
+<h2 style="color:IndianRed;">Methods of Sponsorship</h2>
 
 <p align="justify">
 Currently there is only one way to sponsor the Python project <i>Wordhoard</i>. This method is listed below, which includes additional information about the method. 
 Hopefully, this method works for you.  Additional support methods will be added in the future.  
 </p>
 
-### Method: Buy Me A Coffee
+<h3 style="color:IndianRed;">Method: Buy Me A Coffee</h3>
 
 <p align="justify">
 <i>Buy me a coffee</i> is a service for online creators, such as independent developers building 

docs/basic_usage.md

@@ -1,13 +1,13 @@
-<h1> <strong>Basic Usage</strong> </h1>
+<h1 style="color:IndianRed;"> <strong>Basic Usage</strong> </h1>
+
 ---
 
 
 <p align="justify"> 
 <strong>WordHoard</strong> is a <i>Python 3</i> module that was designed using the rules of simplicity, which try to limit overly complex configuration requirements and keeps backend user intervention to the bare minimum.  
 </p>
 
-
-### Antonyms Module Usage
+<h3 style="color:IndianRed;">Antonyms Module Usage</h3>
 
 <p align="justify"> 
 An <i>antonym</i> is word that has the exact opposite meaning of another word or its antonym.
@@ -33,7 +33,7 @@ print(antonym_results)
 ['dad', 'daddy', 'father', 'old man', 'pa', 'papa', 'pop', 'poppa']
 ```
 
-### Synonyms Module Usage
+<h3 style="color:IndianRed;">Synonyms Module Usage</h3>
 
 <p align="justify">
 A <i>synonym</i> is a word or phrase that means exactly or nearly the same as another word or phrase in the same language.
@@ -64,7 +64,7 @@ print(synonym_results)
 'quintipara', 'source', 'supermom', 'surrogate mother']
 ```
 
-### Definitions Module Usage
+<h3 style="color:IndianRed;">Definitions Module Usage</h3>
 
 <p align="justify">
 A <i>definition</i> is a statement of the exact meaning of a word, especially in a dictionary.
@@ -80,7 +80,7 @@ print(definition_results)
 'female person who has borne children']
 ```
 
-### Homophones Module Usage
+<h3 style="color:IndianRed;">Homophones Module Usage</h3>
 
 <p align="justify">
 A <i>homophone</i> is a word that is pronounced the same as another word but differs in meaning.
@@ -106,7 +106,7 @@ print(homophone_results)
 ['horse is a homophone of hoarse']
 ```
 
-### Hypernyms Module Usage
+<h3 style="color:IndianRed;">Hypernyms Module Usage</h3>
 
 <p align="justify">
 Hypernym: (semantics) A word or phrase whose referents form a set including as a subset the referents of a subordinate term. Musical instrument is a hypernym of "guitar" because a guitar is a musical instrument.
@@ -139,7 +139,7 @@ print(hypernym_results)
 'sum', 'sum of money']
 ```
 
-### Hyponyms Module Usage
+<h3 style="color:IndianRed;">Hyponyms Module Usage</h3>
 
 <p align="justify">
 A <i>hyponym</i> is a word of more specific meaning than a general or superordinate term applicable to it.