Cowsay Demon appearing from the terminal

Run the script to check 'Cowsay Demon' prompt drawed with characters by console.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy on a live system and clone the repository.

• (Option 1): Clone the repository with link "https"

  git clone https://github.com/escummy/cowsay-demon.git

• (Option 2): Clone the repository with link "SSH"

  git clone [email protected]:escummy/cowsay-demon.git

• (Option 3): Download the file.zip to your desktop

# Prerequisites

To continue, you need to have installed: Python 3.11.0

(Check in your terminal bash)

python --version

Else, Install python from the official Santander "Install now" app in the desktop, check versions availables to compare with the available 'version LTS' in ther official documentation.

[English] - https://www.python.org/downloads/ (or) [Spanish] - https://docs.python.org/es/3/tutorial/

Setup a virtual environment for working locally

  $ python -m venv venv

Activate virtual environment before install

• For linux/macOS

  $ source venv\bin\activate

• For windows

  $ .\venv\Scripts\activate

Installing dependencies

Upgrade pip in case of deprecated version to avoid intallation issues.

$ pip install --upgrade pip

Dependencies are defined in requirements.txt and can be installed manually.

$ pip install -r requirements.txt

Run python project

The application can be run locally for testing purposes leveraging the source folder to find exactly the main.py application as follows:

$ python src/main.py

Executing automated tests

Tests are run with pytest leveraging the dependencies defined in requirements-dev.txt including unit-test and global-test, applying documentation from continuous integration with github actions if required.

Break down into end to end tests in development

$ pip install -r requirements-dev.txt

Running tests

Explain what these tests test and why

$ pytest

Repositories use SemVer for versioning, three-digit numbering technique based patter of Major, Minor and Patch fixes, see the release tags for more details about version available.

Contributing

Contributions are always welcome.

See CONTRIBUTING for ways to get started, you can colaborate addings features to improve the repository, you can feel free to suggest anything or help solving issues via pull request.

Please adhere to this project CODE_OF_CONDUCT, examples of behavior that contributes to a positive environment for our community and adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html

[Author]: Gonzalo Cugiani (Amsterdam, North Holland, Netherlands)

• www.github.com/github.com/escummy
• www.linkedin.com/in/gonzalocugiani
• www.stackoverflow.com/gonzalocugiani

About Licenses

A licensor may grant a license under intellectual property laws to authorize a use (such as copying software or using a patented invention) to a licensee, sparing the licensee from a claim of infringement brought by the licensor.

License used for this repository [MIT License]

---

. . .

This README file was updated
Last refresh: Wednesday, 19 Jan, 11:28 CET