diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7c1a33a..7c45275 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,7 +7,7 @@ assignees: '' --- -### Summary +## Summary Provide a brief summary of the issue you're encountering. @@ -19,15 +19,15 @@ Describe the steps you took when you encountered the bug: 2. ... 3. ... -### Expected Behavior +## Expected Behavior What did you expect to happen when you followed the steps above? -### Actual Behavior +## Actual Behavior Describe what actually happened. Include details like error messages or unexpected outcomes. -### Technical Details +## Technical Details Any relevant technical information. Include as much information as possible, including: @@ -35,10 +35,10 @@ Any relevant technical information. Include as much information as possible, inc - **Browser/Application Version**: - **Additional relevant software versions**: -### Proposed Solutions (Optional) +## Proposed Solutions (Optional) If you have any suggestions on how to fix this issue, please share them here. -### Screenshots +## Screenshots Attach any screenshots that help illustrate the issue. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5df86d2..5b86f27 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,18 +7,18 @@ assignees: '' --- -### Is your feature request related to a problem? Please describe +## Is your feature request related to a problem? Please describe A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -### Describe the solution you'd like +## Describe the solution you'd like A clear and concise description of what you want to happen. -### Describe alternatives you've considered +## Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered. -### Additional context +## Additional context Add any other context or screenshots about the feature request here. diff --git a/project_template/.github/ISSUE_TEMPLATE/bug_report.md b/project_template/.github/ISSUE_TEMPLATE/bug_report.md index 7c1a33a..7c45275 100644 --- a/project_template/.github/ISSUE_TEMPLATE/bug_report.md +++ b/project_template/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,7 +7,7 @@ assignees: '' --- -### Summary +## Summary Provide a brief summary of the issue you're encountering. @@ -19,15 +19,15 @@ Describe the steps you took when you encountered the bug: 2. ... 3. ... -### Expected Behavior +## Expected Behavior What did you expect to happen when you followed the steps above? -### Actual Behavior +## Actual Behavior Describe what actually happened. Include details like error messages or unexpected outcomes. -### Technical Details +## Technical Details Any relevant technical information. Include as much information as possible, including: @@ -35,10 +35,10 @@ Any relevant technical information. Include as much information as possible, inc - **Browser/Application Version**: - **Additional relevant software versions**: -### Proposed Solutions (Optional) +## Proposed Solutions (Optional) If you have any suggestions on how to fix this issue, please share them here. -### Screenshots +## Screenshots Attach any screenshots that help illustrate the issue. diff --git a/project_template/.github/ISSUE_TEMPLATE/feature_request.md b/project_template/.github/ISSUE_TEMPLATE/feature_request.md index 5df86d2..5b86f27 100644 --- a/project_template/.github/ISSUE_TEMPLATE/feature_request.md +++ b/project_template/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,18 +7,18 @@ assignees: '' --- -### Is your feature request related to a problem? Please describe +## Is your feature request related to a problem? Please describe A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -### Describe the solution you'd like +## Describe the solution you'd like A clear and concise description of what you want to happen. -### Describe alternatives you've considered +## Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered. -### Additional context +## Additional context Add any other context or screenshots about the feature request here. diff --git a/project_template/Makefile.jinja b/project_template/Makefile.jinja index e149a49..e0ab16b 100644 --- a/project_template/Makefile.jinja +++ b/project_template/Makefile.jinja @@ -34,6 +34,10 @@ test: ## Run the tests and check coverage. mypy: ## Run mypy. {{ package_manager }} run mypy {{ module_name }} +.PHONY: run +run: ## Run the python script + {{ package_manager }} run python -m {{ module_name }} + .PHONY: install install: ## Install the dependencies excluding dev. {% if package_manager == "poetry" -%} diff --git a/project_template/{{module_name}}/__main__.py.jinja b/project_template/{{module_name}}/__main__.py.jinja new file mode 100644 index 0000000..ea5ac9f --- /dev/null +++ b/project_template/{{module_name}}/__main__.py.jinja @@ -0,0 +1,26 @@ +from decimal import Decimal + +from {{module_name}}.calculator import Calculator + + +def main() -> None: + calculator = Calculator() + + total = calculator.add(Decimal("10.50")) + print(f"After add: {total}") + + total = calculator.subtract(Decimal("2.25")) + print(f"After subtract: {total}") + + total = calculator.multiply(Decimal("3")) + print(f"After multiply: {total}") + + total = calculator.divide(Decimal("4")) + print(f"After divide: {total}") + + calculator.reset_cumulative_total() + print(f"After reset: {calculator.cumulative_total}") + + +if __name__ == "__main__": + main()