Python Starter Project

This is a boilerplate application that will help users to set up a Python project with some initial configuration. It includes a basic file structure, dependencies, and scripts to run and test the application.

Prerequisites

Before you get started, make sure you have the following prerequisites installed on your machine:

1. Python 3.x
2. pip package manager
3. virtualenv

Installation

Clone the repository to your local machine using Git:

git clone https://github.com/idipanshu/python-starter-project.git

Navigate to the project directory:

cd python-starter-project

Create a virtual environment and activate it:

pipenv install
pipenv shell

Install the dependencies:

pipenv install

Usage

Once you have installed the project, you can run it by executing the following command:

python main.py

This will run the main Python file and display the output on the console.

Testing

To run the unit tests, use the following command:

make test
# or
python -m unittest discover

This will run all the unit tests in the tests directory.

Contributing

If you would like to contribute to this project, please fork the repository and create a new branch. Make your changes, commit them, and then create a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details