organized codebase, added pytest cases

Author: VaasuDevanS

.github/workflows/cowsay.yaml

@@ -8,17 +8,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
+      - name: Test with Pytest
         run: |
-          python -m pip install --upgrade pip
-      - name: Test with unittest
-        run: |
-          python -m unittest
+          pytest

.gitignore

@@ -1,6 +1,160 @@
-.vscode
-venv
-build
-dist
-*egg-info
-__pycache__/
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.idea/cowsay-python.iml

@@ -1,10 +1,23 @@
-Change Log
-==========
+# Change Log
 
 All notable changes to this project will be documented in this file
 
 ___
 
+## v6.0 (Sep 15, 2023)
+
+## Added
+- Added CONTRIBUTING.md guide on how to add new characters
+- Exposed `cowsay.draw` method to draw custom characters
+- <b>New character</b>: Octopus (Added by [druhi](https://github.com/druhi))
+
+## Changed
+- Dropped support for Python 3.6 and 3.7
+- Updated to use pytest and added more tests!
+- Simplified the entire codebase and removed unnecessary files
+
+___
+
 ## v5.0 (Jun 21, 2022)
 
 ## Added
@@ -36,7 +49,7 @@ ___
 
 ## Added
 - <b>New character</b>: Pig (Added by [Gerald Sornsen](https://github.com/gsornsen))<br>
-- Command line compatability (Added by [Chad Smith](https://github.com/cs01))
+- Command line compatibility (Added by [Chad Smith](https://github.com/cs01))
 
 ___
 

.idea/misc.xml

@@ -0,0 +1,62 @@
+# Adding a new Character
+1. Choose the new character and first test it's output using `cowsay.draw` method
+   ```
+   # https://www.asciiart.eu/animals
+   
+   >>> scorpion = r"""
+    \
+     \
+      \
+       ___    ___
+      ( _<    >_ )
+      //        \\
+      \\___..___//
+       `-(    )-'
+         _|__|_
+        /_|__|_\
+        /_|__|_\
+        /_\__/_\
+         \ || /  _)
+           ||   ( )
+           \\___//
+            `---'
+   """
+   
+   >>> cowsay.draw('Hello I am Scorpion', scorpion)
+     ___________________
+    | Hello I am Scorpion |
+     ===================
+                    \
+                     \
+                      \
+                       ___    ___
+                      ( _<    >_ )
+                      //        \\
+                      \\___..___//
+                       `-(    )-'
+                         _|__|_
+                        /_|__|_\
+                        /_|__|_\
+                        /_\__/_\
+                         \ || /  _)
+                           ||   ( )
+                           \\___//
+                            `---'
+   ```
+2. Fork the repo here https://github.com/VaasuDevanS/cowsay-python/fork   
+3. Once the character and it's output are finalized, add the character in 
+   `cowsay/characters.py` and it's expected solution in `cowsay/tests/solutions.py`
+4. Add the character name in `test_char_names` function in `cowsay/tests/test_api.py`
+5. Update `README.md` (`More Characters` section)
+6. Run the test suite locally using `pytest`
+7. Create a `Pull Request`
+
+
+# Updating the codebase
+Feel free to create a pull request to make any desired changes 
+to the code without breaking the API :-)
+
+
+# Adding new functionality
+Feel free to create a pull request if you want to add more
+functionality (like customizations to each characters, ...)