Service component that will send birthday wishes to employees with the ability be extended by developers to send any type of notifications for an organization
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Things you need to get start with the service and how to install them.
- Python 3.6 >=
- Pip
- Pipenv - Pipenv is optional, you could use the standard pip for dependencies
A step by step series of examples that tell you how to get a development env running
After installing Python and Pip or Pipenv you need to install the dependencies.
Using Pip:
pip install -r requirements.txt
Using Pipenv:
pipenv install -d
It's always best pratice to use a virtual enviornment, pipenv handles virtual enviornments for you out the box but pip doesn't. read more about virtual environments in python here
Create a .env file in the root directory which will contain your environment variables for the service. You can copy
the .env.example file which has an example of required environment variables for the service. Optional you can set the
environment variables on your OS and the project should read them from there.
Run this command to run the default birthday notification
python main.py
To run tests, run this command in the project root directory
pytest
Run test with coverage
pytest --cov
- Love - The thing that makes the world go round
- Coffee - Energy Management for developers
- Computer - Used to generate code
Wide wild west - Anything goes.
- Stackoverflow
- Github
- Youtube
- etc