PythonTemplate

This repository serves as a foundational template for new python projects, equipped with essential tools for maintaining code quality and documentation consistency. It includes:

1. README.md
2. LICENSE
3. .gitignore
4. CODE_OF_CONDUCT.md
5. CONTRIBUTING.md
6. FUNDING.yml
7. CHANGELOG.md

Table of Contents

1. Getting Started
2. Build
3. Run
4. Testing
5. Cleaning

Getting Started

To get started with the project, ensure you have Python 3 installed on your system.

Build

To create virtualenv and install requirements for the project, run the following command:

make build

Run

To run the main file, use the following command:

make run

You can also specify a particular file to run by adding the FILE variable:

Note: Path need to be mentioned if it's in a directory

make run FILE=file_name.py
or
make run FILE=app/app.py

Testing

To run the tests, use the following command:

make test

You can also specify a particular file to test by adding the FILE variable:

Note: Path need to be mentioned if it's in a directory

make test FILE=file_name.py

Cleaning

To clean the project directory, removing all compiled Python files, use the following command:

make clean

Contributing

Contributions are welcome! Please read our Contribution Guidelines before submitting pull requests.

License

This project is licensed under the Apache License 2.0 License - see the LICENSE file for details.