Fix errors

Author: amrabed

.github/CODEOWNERS

@@ -0,0 +1 @@
+/** @amrabed

.github/workflows/check.yml

@@ -3,8 +3,6 @@ name: Format, Lint, and Test
 on:
   workflow_call:
   push:
-    paths:
-      - "!docs/**"
 
 jobs:
   check:

Makefile

@@ -4,19 +4,21 @@ DESCRIPTION ?= Python Project Template
 AUTHOR ?= Amr Abed
 EMAIL ?= amrabed
 GITHUB ?= amrabed
+SOURCE ?= $(shell echo ${NAME} | tr '-' '_' | tr '[:upper:]' '[:lower:]')
 
 .PHONY: project
 project: # Rename project (run once)
-	@if [ -d project ]; then mv project ${NAME}; fi
-	@sed -i '' 's/^::: project\.app/::: ${NAME}\.app/' docs/reference/app.md
-	@sed -i '' 's/^repo_name: "Project"/repo_name: "${NAME}"/' mkdocs.yml
-	@sed -i '' 's/^repo_url: ".*"/repo_url: "https:\/\/github.com\/${GITHUB}\/${NAME}"/' mkdocs.yml
-	@sed -i '' 's/^source = \[.*\]/source = \["${NAME}"\]/' pyproject.toml
-	@sed -i '' 's/^app = "project\.app:main"/app = "${NAME}\.app:main"/' pyproject.toml
-	@sed -i '' 's/^name = ".*"/name = "${NAME}"/' pyproject.toml
+	@if [ -d project ]; then mv project ${SOURCE}; fi
+	@sed -i '' 's/^::: project\.app/::: ${SOURCE}\.app/' docs/reference/app.md
+	@sed -i '' 's/^repo_name: .*/repo_name: ${GITHUB}\/${NAME}/' mkdocs.yml
+	@sed -i '' 's/^repo_url: .*/repo_url: https:\/\/github.com\/${GITHUB}\/${NAME}/' mkdocs.yml
+	@sed -i '' 's/^source = \[.*\]/source = \["${SOURCE}"\]/' pyproject.toml
+	@sed -i '' 's/^app = "project\.app:main"/app = "${SOURCE}\.app:main"/' pyproject.toml
+	@sed -i '' 's/^name = ".*"/name = "${SOURCE}"/' pyproject.toml
 	@sed -i '' 's/^description = ".*"/description = "${DESCRIPTION}"/' pyproject.toml
 	@sed -i '' 's/^authors = \[.*\]/authors = \["${AUTHOR} <${EMAIL}>"\]/' pyproject.toml
 	@sed -i '' 's/^# .*/# ${DESCRIPTION}/' docs/README.md
+	@sed -i '' 's/@.*/@${GITHUB}/' .github/CODEOWNERS
 	@sed -i '' 's/^github: \[.*\]/github: \[${GITHUB}\]/' .github/FUNDING.yml
 	@sed -i '' 's/^patreon: .*/patreon: # Put your Patreon username here/' .github/FUNDING.yml
 

docs/CONTRIBUTING.md

@@ -36,34 +36,32 @@ You'll need the following prerequisites:
 
 ### How to contribute
 
-1. Fork the repository on GitHub 
-2. Clone your fork locally.
-3. Install the project dependencies:
+- Fork the repository on GitHub 
+- Clone your fork locally.
+- Install the project dependencies:
 
 ```bash
 make poetry install pre-commit
 ```
-4. Create a new branch (wit a descriptive name) for your changes:
+- Create a new branch (with a descriptive name) for your changes:
 
 ```bash
 git checkout -b my-new-feature  # use descriptive branch name
 ```
-5. Make your code changes
-
-6. Run tests and linting locally to make sure everything is working as expected.
+- Make your code changes
+- Run tests and linting locally to make sure everything is working as expected.
 
 ```bash
 make lint test
 ```
-7. Commit your changes and push your branch to GitHub
-
+- Commit your changes and push your branch to GitHub
 ```bash
 git add .
 git commit -m "My new feature"  # use descriptive commit message
-git push origin my-new-feature-branch
+git push origin my-new-feature
 ```
+- Create a pull request, and request review from the team
 
-8. Create a pull request, and request review from the team
 > Please follow the pull request template and fill in as much information as possible. Link to any relevant issues and include a description of your changes.
 
 

docs/README.md

@@ -23,9 +23,9 @@ The repository also comes pre-loaded with these GitHub files:
 
 - Pull request template
 - Issue templates
-  - Bug report
-  - Feature request
-  - Question
+    + Bug report
+    + Feature request
+    + Question
 - Contributing guidelines
 - Funding file
 - Code owners
@@ -39,14 +39,15 @@ Click this button to create a new repository for your project, then clone the ne
 ### Rename the project
 After cloning the repository, rename the project by running:
 ```bash
-make project NAME="" DESCRIPTION="" AUTHOR="" EMAIL="" GITHUB=""
+make project NAME="" DESCRIPTION="" AUTHOR="" EMAIL="" GITHUB="" SOURCE=""
 ```
 Pass the following parameters:
 
 Parameter | Description
 --- | ---
 `NAME` | Project new name
 `DESCRIPTION` | Project short description
+`SOURCE` | (optional) Source folder name
 `AUTHOR` | Author name
 `EMAIL`| Author email 
 `GITHUB`| GitHub username (for GitHub funding)

mkdocs.yml

@@ -1,6 +1,7 @@
 site_name: Project Documentation
-repo_url: "https://github.com/amrabed/python-project-template"
-repo_name: "Project"
+repo_url: https://github.com/amrabed/python-project-template
+repo_name: amrabed/python-project-template
+edit_uri: edit/main/docs/
 # copyright: Copyright © 2024 
 
 theme:

project/app.py

@@ -3,9 +3,9 @@
 
 @command(context_settings={"help_option_names": ["-h", "--help"]}, help="Say hello")
 @option("-n", "--name", default="World", help="Name", show_default=True)
-def hello(name: str = "World"):
+def main(name: str = "World"):
     """
-    Say hello to the given name
+    Say hello to the given name.
 
     Args:
       name: the name to be greeted
@@ -14,4 +14,4 @@ def hello(name: str = "World"):
 
 
 if __name__ == "__main__":
-    hello()
+    main()