feat: initial cookiecutter template

Author: Joris Conijn

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: check-merge-conflict
+      - id: check-json
+      - id: detect-aws-credentials
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2022 Binx.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,16 @@
+# Cookiecutter: python-cli-tool
+
+This repository contains a boilerplate (using [cookiecutter](https://www.cookiecutter.io)) for starting a python cli application hosted on [github](https://github.com).
+
+## Prerequisites
+
+```bash
+brew install python3 cookiecutter poetry
+```
+## Usage
+
+You can use this project as a starting point by executing:
+
+```bash
+cookiecutter gh:binxio/python-cli-tool
+```

cookiecutter.json

@@ -0,0 +1,5 @@
+{
+    "project_name": "python-cli-tool",
+    "description": "TODO: Describe me",
+    "pkg_name": "{{ cookiecutter.project_name|replace('-', '_') }}"
+}

{{cookiecutter.project_name}}/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,42 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug, triage
+assignees: ''
+
+---
+
+<!--- Provide a general summary of the issue in the Title above -->
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+
+**What were you trying to accomplish?**
+
+## Expected Behavior
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Steps to Reproduce (for bugs)
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Environment
+
+* **version used**:
+* **Debugging logs**
+
+```python
+# paste logs here
+```

{{cookiecutter.project_name}}/.github/ISSUE_TEMPLATE/documentation_improvements.md

@@ -0,0 +1,17 @@
+---
+name: Documentation improvements
+about: Suggest a documentation update
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**What were you initially searching for in the docs?**
+<!-- Please help us understand how you looked for information that was either not available or unclear -->
+
+**Is this related to an existing part of the documentation? Please share a link**
+
+**Describe how we could make it clearer**
+
+**If you have a proposed update, please share it here**

{{cookiecutter.project_name}}/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature-request, triage
+assignees: ''
+
+---
+
+**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**
+<!-- A clear and concise description of what you want to happen. -->
+
+**Describe alternatives you've considered**
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+**Additional context**
+<!-- Add any other context or screenshots about the feature request here. -->

{{cookiecutter.project_name}}/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+**Issue #, if available:**
+
+## Description of changes:
+
+<!--- One or two sentences as a summary of what's being changed -->
+
+**Checklist**
+
+<!--- Leave unchecked if your change doesn't seem to apply -->
+
+* [ ] Update tests
+* [ ] Update docs
+* [ ] PR title follows [conventional commit semantics](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#commit-message-for-a-fix-using-an-optional-issue-number)
+
+By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

{{cookiecutter.project_name}}/.github/auto_assign-issues.yml

@@ -0,0 +1 @@
+addAssignees: true

{{cookiecutter.project_name}}/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "poetry" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"