templatepy 0.2.0__tar.gz → 0.2.3__tar.gz

templatepy-0.2.3/.bumpversion.cfg

@@ -0,0 +1,32 @@
+[bumpversion]
+current_version = 0.2.3
+commit = True
+tag = False
+tag_name = v{new_version}
+sign_tags = False
+message = "Upgrade: {current_version} → {new_version}"
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+)(?P<build>\d+))?
+serialize = 
+	{major}.{minor}.{patch}.{release}{build}
+	{major}.{minor}.{patch}
+
+[bumpversion:part:release]
+optional_value = rc
+first_value = dev
+values = 
+	dev
+	rc
+
+[bumpversion:part:build]
+
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"
+
+[bumpversion:file:README.md]
+search = Version: "{current_version}"
+replace = Version: "{new_version}"
+
+[bumpversion:file:templatepy/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"

templatepy-0.2.3/.gitignore

@@ -0,0 +1,139 @@
+# IDE files
+.idea/
+.vscode/
+
+# Ignored file types
+.DS_Store
+
+# Custom config files
+*.conf.custom
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

templatepy-0.2.3/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+-   repo: https://github.com/asottile/reorder_python_imports
+    rev: v2.6.0
+    hooks:
+    -   id: reorder-python-imports
+-   repo: https://github.com/ambv/black
+    rev: 22.6.0
+    hooks:
+    - id: black
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    - id: end-of-file-fixer
+      exclude: '.bumpversion.cfg'
+    - id: trailing-whitespace
+      exclude: '.bumpversion.cfg'
+    - id: check-case-conflict
+    - id: check-merge-conflict
+    - id: check-yaml
+      args: [ '--unsafe' ]
+    - id: detect-private-key
+    - id: forbid-new-submodules
+    - id: check-json
+    - id: pretty-format-json
+      args: ['--autofix', '--indent=4', '--no-ensure-ascii', ]
+    - id: check-added-large-files
+    - id: flake8

templatepy-0.2.3/.secrets.baseline

@@ -0,0 +1,127 @@
+{
+  "version": "1.5.0",
+  "plugins_used": [
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "name": "Base64HighEntropyString",
+      "limit": 4.5
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "name": "DiscordBotTokenDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "name": "GitLabTokenDetector"
+    },
+    {
+      "name": "HexHighEntropyString",
+      "limit": 3.0
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "IPPublicDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "name": "KeywordDetector",
+      "keyword_exclude": ""
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "OpenAIDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "PypiTokenDetector"
+    },
+    {
+      "name": "SendGridDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TelegramBotTokenDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "filters_used": [
+    {
+      "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
+    },
+    {
+      "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
+      "min_level": 2
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_indirect_reference"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_likely_id_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_lock_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_potential_uuid"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_sequential_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_swagger_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_templated_secret"
+    }
+  ],
+  "results": {},
+  "generated_at": "2024-11-29T20:27:51Z"
+}

templatepy-0.2.3/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+L.B.Rollik@protonmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

templatepy-0.2.3/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+## Contributing
+
+Contributions are absolutely encouraged, for bug fixes, new features, etc.
+
+If you are not sure where to start, check out the [issues](https://github.com/larsrollik/templatepy/issues).
+
+Please get in touch via [email](mailto:L.B.Rollik@protonmail.com) for other queries.

{templatepy-0.2.0/templatepy.egg-info → templatepy-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: templatepy
-Version: 0.2.0
+Version: 0.2.3
 Summary: templatepy: template for derivative python packages
 Author-email: "Lars B. Rollik" <L.B.Rollik@protonmail.com>
 License: BSD 3-Clause License
@@ -52,6 +52,7 @@ Requires-Dist: bump2version; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: flake8; extra == "dev"
+Requires-Dist: toml; extra == "dev"
 
 [//]: # (Links)
 [Github-flavored markdown]: https://github.github.com/gfm
@@ -90,7 +91,7 @@ Requires-Dist: flake8; extra == "dev"
 # templatepy
 Template repo for python repositories & PyPi integration
 ---
-**Version: "0.2.0"**
+**Version: "0.2.3"**
 
 
 ## Usage
@@ -185,10 +186,10 @@ The pipeline ensures code quality, passing tests, and automated deployment on ne
 
 - [ ] Change package name:
   - (1) Rename the `templatepy` folder.
-  - (2) Update all occurrences in `README.md`.
+  - (2) Update all occurrences  of `templatepy` in `README.md`.
   - (3) Update the `name` field in `pyproject.toml`.
-  - (4) Update `.github/workflows` files.
-  - (5) Update version references in `pyproject.toml` and `templatepy/__init__.py`.
+  - (4) (optional) Update `.github/workflows` files.
+  - (5) Reset version references in `pyproject.toml` and `templatepy/__init__.py` to `0.0.0.dev0`.
 - [ ] Update project author and metadata details in `pyproject.toml`, `README.md`, and `templatepy/__init__.py`.
 - [ ] Update the license holder in the `LICENSE` file.
 - [ ] Update `README.md` badge paths at the top.
@@ -230,18 +231,80 @@ The package will then be automatically uploaded to [PyPI](https://pypi.org/) or
 `bump2version` is used to increment version numbers based on semantic versioning. Here’s how you can use it with the current setup to trigger a release:
 
 1. **Bumping the Minor Version**:
-   Increment the minor version (e.g., from `1.2.3` to `1.3.0`):
+   Increment the minor version (e.g., from `v1.2.3` to `v1.3.0`):
    ```bash
    # Bumping the minor Version:
    bump2version minor
 
-   # Bumping the major version (e.g., from 1.2.3 to 2.0.0):
+   # Bumping the major version (e.g., from v1.2.3 to v2.0.0):
    bump2version major
 
-   # Bumping for a release Version (e.g., from 1.0.0.dev to 1.0.0.rc or 1.0.0):
+   # Bumping for a release Version (e.g., from v1.0.0.dev to v1.0.0.rc or v1.0.0):
    bump2version release
    ```
 
+## Workflows Summary
+
+| **Workflow**               | **Triggers**                                      | **Purpose**                                | **Outputs**                            |
+|----------------------------|---------------------------------------------------|--------------------------------------------|----------------------------------------|
+| **Lint and Test**          | Push to any branch                                | Runs linting and testing for Python code   | Ensures code quality and functionality |
+| **Release to PyPI**        | Push to `prod` branch with a tag (e.g., `v1.0.0`) | Builds and uploads the package to PyPI     | Publishes a new release on PyPI        |
+| **Squash Merge to `prod`** | Pull requests merged into `main`                  | Squashes and merges commits into `prod`    | Maintains clean history in `prod`      |
+| **AI Pull Request Review** | Pull request events (`opened`, `synchronize`)     | Provides AI-generated pull request reviews | Adds review comments to the PR         |
+
+
+## Required Repository Secrets
+
+| **Secret**       | **Purpose**                                 | **How to Obtain**                                                                           |
+|------------------|---------------------------------------------|---------------------------------------------------------------------------------------------|
+| `TWINE_API_KEY`  | Authentication for publishing to PyPI       | Generate from [PyPI Account Settings](https://pypi.org/manage/account/) under "API Tokens." |
+| `OPENAI_API_KEY` | Required for AI Pull Request Reviewer       | Generate from [OpenAI API Settings](https://platform.openai.com/account/api-keys).          |
+| `GITHUB_TOKEN`   | Built-in token for accessing the repository | Automatically provided by GitHub (no setup needed).                                         |
+
+
+## Github Flow overview
+
+
+1) Create a new feature branch from main using git checkout -b.
+2) Make and commit a dummy change (e.g., adding a file).
+3) Use bumpversion to bump the version (you can adjust patch, minor, or major based on what change you want), and create a release tag.
+4) Push both the feature branch and the release tag to the remote repository.
+5) Open a pull request using GitHub CLI (gh pr create) or the GitHub UI to merge the feature branch into main.
+6) After the PR is merged, delete the feature branch both locally and remotely.
+
+### Example commands for the workflow:
+
+```bash
+# 1. Checkout a new feature branch from main
+git checkout main  # Ensure you are on the main branch
+git pull origin main  # Fetch latest changes from main
+git checkout -b feature/my-new-feature  # Create and switch to a new feature branch
+
+# 2. Make a dummy commit (e.g., add a new file or change)
+echo "Some feature work" > feature.txt  # Add a new file or make a change
+git add feature.txt  # Stage the file for commit
+git commit -m "Add feature.txt - dummy commit"  # Commit the changes
+
+# 3. Bump the version and automatically tag the release
+# (Bumpversion will handle both version bumping and tagging)
+bumpversion patch  # Bumps version, e.g., from v0.1.0 to v0.1.1 (adjust based on version part you want)
+
+# 4. Push the changes to remote (feature branch and the tag)
+git push origin feature/my-new-feature  # Push the feature branch
+git push origin --tags  # Push the new tag(s) created by bumpversion
+
+# 5. Open a pull request from the feature branch to the main branch
+# This can be done via GitHub UI, or using GitHub CLI
+gh pr create --base main --head feature/my-new-feature --title "New Feature" --body "This is a new feature that adds feature.txt."
+
+# 6. After the PR is accepted and merged, delete the feature branch locally and remotely
+git checkout main  # Switch back to main branch
+git pull origin main  # Ensure your main branch is up-to-date
+git branch -d feature/my-new-feature  # Delete the local feature branch
+git push origin --delete feature/my-new-feature  # Delete the remote feature branch
+
+```
+
 ## Notes
 
 #### New(er) Build System with `pyproject.toml` and `setup.cfg`
@@ -306,5 +369,6 @@ ssb   4096R/<KEY_SUBKEY_ID> 2024-11-22
 Contributions are very welcome!
 Please see the [contribution guidelines] or check out the [issues]
 
+
 ## License
 This software is released under the **[BSD 3-Clause License]**

{templatepy-0.2.0 → templatepy-0.2.3}/README.md

@@ -35,7 +35,7 @@
 # templatepy
 Template repo for python repositories & PyPi integration
 ---
-**Version: "0.2.0"**
+**Version: "0.2.3"**
 
 
 ## Usage
@@ -130,10 +130,10 @@ The pipeline ensures code quality, passing tests, and automated deployment on ne
 
 - [ ] Change package name:
   - (1) Rename the `templatepy` folder.
-  - (2) Update all occurrences in `README.md`.
+  - (2) Update all occurrences  of `templatepy` in `README.md`.
   - (3) Update the `name` field in `pyproject.toml`.
-  - (4) Update `.github/workflows` files.
-  - (5) Update version references in `pyproject.toml` and `templatepy/__init__.py`.
+  - (4) (optional) Update `.github/workflows` files.
+  - (5) Reset version references in `pyproject.toml` and `templatepy/__init__.py` to `0.0.0.dev0`.
 - [ ] Update project author and metadata details in `pyproject.toml`, `README.md`, and `templatepy/__init__.py`.
 - [ ] Update the license holder in the `LICENSE` file.
 - [ ] Update `README.md` badge paths at the top.
@@ -175,18 +175,80 @@ The package will then be automatically uploaded to [PyPI](https://pypi.org/) or
 `bump2version` is used to increment version numbers based on semantic versioning. Here’s how you can use it with the current setup to trigger a release:
 
 1. **Bumping the Minor Version**:
-   Increment the minor version (e.g., from `1.2.3` to `1.3.0`):
+   Increment the minor version (e.g., from `v1.2.3` to `v1.3.0`):
    ```bash
    # Bumping the minor Version:
    bump2version minor
 
-   # Bumping the major version (e.g., from 1.2.3 to 2.0.0):
+   # Bumping the major version (e.g., from v1.2.3 to v2.0.0):
    bump2version major
 
-   # Bumping for a release Version (e.g., from 1.0.0.dev to 1.0.0.rc or 1.0.0):
+   # Bumping for a release Version (e.g., from v1.0.0.dev to v1.0.0.rc or v1.0.0):
    bump2version release
    ```
 
+## Workflows Summary
+
+| **Workflow**               | **Triggers**                                      | **Purpose**                                | **Outputs**                            |
+|----------------------------|---------------------------------------------------|--------------------------------------------|----------------------------------------|
+| **Lint and Test**          | Push to any branch                                | Runs linting and testing for Python code   | Ensures code quality and functionality |
+| **Release to PyPI**        | Push to `prod` branch with a tag (e.g., `v1.0.0`) | Builds and uploads the package to PyPI     | Publishes a new release on PyPI        |
+| **Squash Merge to `prod`** | Pull requests merged into `main`                  | Squashes and merges commits into `prod`    | Maintains clean history in `prod`      |
+| **AI Pull Request Review** | Pull request events (`opened`, `synchronize`)     | Provides AI-generated pull request reviews | Adds review comments to the PR         |
+
+
+## Required Repository Secrets
+
+| **Secret**       | **Purpose**                                 | **How to Obtain**                                                                           |
+|------------------|---------------------------------------------|---------------------------------------------------------------------------------------------|
+| `TWINE_API_KEY`  | Authentication for publishing to PyPI       | Generate from [PyPI Account Settings](https://pypi.org/manage/account/) under "API Tokens." |
+| `OPENAI_API_KEY` | Required for AI Pull Request Reviewer       | Generate from [OpenAI API Settings](https://platform.openai.com/account/api-keys).          |
+| `GITHUB_TOKEN`   | Built-in token for accessing the repository | Automatically provided by GitHub (no setup needed).                                         |
+
+
+## Github Flow overview
+
+
+1) Create a new feature branch from main using git checkout -b.
+2) Make and commit a dummy change (e.g., adding a file).
+3) Use bumpversion to bump the version (you can adjust patch, minor, or major based on what change you want), and create a release tag.
+4) Push both the feature branch and the release tag to the remote repository.
+5) Open a pull request using GitHub CLI (gh pr create) or the GitHub UI to merge the feature branch into main.
+6) After the PR is merged, delete the feature branch both locally and remotely.
+
+### Example commands for the workflow:
+
+```bash
+# 1. Checkout a new feature branch from main
+git checkout main  # Ensure you are on the main branch
+git pull origin main  # Fetch latest changes from main
+git checkout -b feature/my-new-feature  # Create and switch to a new feature branch
+
+# 2. Make a dummy commit (e.g., add a new file or change)
+echo "Some feature work" > feature.txt  # Add a new file or make a change
+git add feature.txt  # Stage the file for commit
+git commit -m "Add feature.txt - dummy commit"  # Commit the changes
+
+# 3. Bump the version and automatically tag the release
+# (Bumpversion will handle both version bumping and tagging)
+bumpversion patch  # Bumps version, e.g., from v0.1.0 to v0.1.1 (adjust based on version part you want)
+
+# 4. Push the changes to remote (feature branch and the tag)
+git push origin feature/my-new-feature  # Push the feature branch
+git push origin --tags  # Push the new tag(s) created by bumpversion
+
+# 5. Open a pull request from the feature branch to the main branch
+# This can be done via GitHub UI, or using GitHub CLI
+gh pr create --base main --head feature/my-new-feature --title "New Feature" --body "This is a new feature that adds feature.txt."
+
+# 6. After the PR is accepted and merged, delete the feature branch locally and remotely
+git checkout main  # Switch back to main branch
+git pull origin main  # Ensure your main branch is up-to-date
+git branch -d feature/my-new-feature  # Delete the local feature branch
+git push origin --delete feature/my-new-feature  # Delete the remote feature branch
+
+```
+
 ## Notes
 
 #### New(er) Build System with `pyproject.toml` and `setup.cfg`
@@ -251,5 +313,6 @@ ssb   4096R/<KEY_SUBKEY_ID> 2024-11-22
 Contributions are very welcome!
 Please see the [contribution guidelines] or check out the [issues]
 
+
 ## License
 This software is released under the **[BSD 3-Clause License]**

{templatepy-0.2.0 → templatepy-0.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "templatepy"
-version = "0.2.0"
+version = "0.2.3"
 authors = [
     { name = "Lars B. Rollik", email = "L.B.Rollik@protonmail.com" }
 ]
@@ -37,7 +37,8 @@ dev = [
     "bump2version",
     "pytest-cov",  # implies: pytest, coverage dependencies
     "pre-commit",
-    "flake8"
+    "flake8",
+    "toml",
 ]
 
 [project.entry-points.console_scripts]

{templatepy-0.2.0 → templatepy-0.2.3}/templatepy/__init__.py

@@ -1,7 +1,7 @@
 __author__ = "Lars B. Rollik"
-__version__ = "0.2.0"
+__version__ = "0.2.3"
 
 
 def run():
     """Example `run` function for entrypoint in `setup.cfg`"""
-    pass
+    print("Hello, world!")

templatepy-0.2.3/templatepy/example.data.file.test-extension-yu48

@@ -0,0 +1,2 @@
+[unused-config-file-2]
+    attribute2 = 2

{templatepy-0.2.0 → templatepy-0.2.3/templatepy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: templatepy
-Version: 0.2.0
+Version: 0.2.3
 Summary: templatepy: template for derivative python packages
 Author-email: "Lars B. Rollik" <L.B.Rollik@protonmail.com>
 License: BSD 3-Clause License
@@ -52,6 +52,7 @@ Requires-Dist: bump2version; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: flake8; extra == "dev"
+Requires-Dist: toml; extra == "dev"
 
 [//]: # (Links)
 [Github-flavored markdown]: https://github.github.com/gfm
@@ -90,7 +91,7 @@ Requires-Dist: flake8; extra == "dev"
 # templatepy
 Template repo for python repositories & PyPi integration
 ---
-**Version: "0.2.0"**
+**Version: "0.2.3"**
 
 
 ## Usage
@@ -185,10 +186,10 @@ The pipeline ensures code quality, passing tests, and automated deployment on ne
 
 - [ ] Change package name:
   - (1) Rename the `templatepy` folder.
-  - (2) Update all occurrences in `README.md`.
+  - (2) Update all occurrences  of `templatepy` in `README.md`.
   - (3) Update the `name` field in `pyproject.toml`.
-  - (4) Update `.github/workflows` files.
-  - (5) Update version references in `pyproject.toml` and `templatepy/__init__.py`.
+  - (4) (optional) Update `.github/workflows` files.
+  - (5) Reset version references in `pyproject.toml` and `templatepy/__init__.py` to `0.0.0.dev0`.
 - [ ] Update project author and metadata details in `pyproject.toml`, `README.md`, and `templatepy/__init__.py`.
 - [ ] Update the license holder in the `LICENSE` file.
 - [ ] Update `README.md` badge paths at the top.
@@ -230,18 +231,80 @@ The package will then be automatically uploaded to [PyPI](https://pypi.org/) or
 `bump2version` is used to increment version numbers based on semantic versioning. Here’s how you can use it with the current setup to trigger a release:
 
 1. **Bumping the Minor Version**:
-   Increment the minor version (e.g., from `1.2.3` to `1.3.0`):
+   Increment the minor version (e.g., from `v1.2.3` to `v1.3.0`):
    ```bash
    # Bumping the minor Version:
    bump2version minor
 
-   # Bumping the major version (e.g., from 1.2.3 to 2.0.0):
+   # Bumping the major version (e.g., from v1.2.3 to v2.0.0):
    bump2version major
 
-   # Bumping for a release Version (e.g., from 1.0.0.dev to 1.0.0.rc or 1.0.0):
+   # Bumping for a release Version (e.g., from v1.0.0.dev to v1.0.0.rc or v1.0.0):
    bump2version release
    ```
 
+## Workflows Summary
+
+| **Workflow**               | **Triggers**                                      | **Purpose**                                | **Outputs**                            |
+|----------------------------|---------------------------------------------------|--------------------------------------------|----------------------------------------|
+| **Lint and Test**          | Push to any branch                                | Runs linting and testing for Python code   | Ensures code quality and functionality |
+| **Release to PyPI**        | Push to `prod` branch with a tag (e.g., `v1.0.0`) | Builds and uploads the package to PyPI     | Publishes a new release on PyPI        |
+| **Squash Merge to `prod`** | Pull requests merged into `main`                  | Squashes and merges commits into `prod`    | Maintains clean history in `prod`      |
+| **AI Pull Request Review** | Pull request events (`opened`, `synchronize`)     | Provides AI-generated pull request reviews | Adds review comments to the PR         |
+
+
+## Required Repository Secrets
+
+| **Secret**       | **Purpose**                                 | **How to Obtain**                                                                           |
+|------------------|---------------------------------------------|---------------------------------------------------------------------------------------------|
+| `TWINE_API_KEY`  | Authentication for publishing to PyPI       | Generate from [PyPI Account Settings](https://pypi.org/manage/account/) under "API Tokens." |
+| `OPENAI_API_KEY` | Required for AI Pull Request Reviewer       | Generate from [OpenAI API Settings](https://platform.openai.com/account/api-keys).          |
+| `GITHUB_TOKEN`   | Built-in token for accessing the repository | Automatically provided by GitHub (no setup needed).                                         |
+
+
+## Github Flow overview
+
+
+1) Create a new feature branch from main using git checkout -b.
+2) Make and commit a dummy change (e.g., adding a file).
+3) Use bumpversion to bump the version (you can adjust patch, minor, or major based on what change you want), and create a release tag.
+4) Push both the feature branch and the release tag to the remote repository.
+5) Open a pull request using GitHub CLI (gh pr create) or the GitHub UI to merge the feature branch into main.
+6) After the PR is merged, delete the feature branch both locally and remotely.
+
+### Example commands for the workflow:
+
+```bash
+# 1. Checkout a new feature branch from main
+git checkout main  # Ensure you are on the main branch
+git pull origin main  # Fetch latest changes from main
+git checkout -b feature/my-new-feature  # Create and switch to a new feature branch
+
+# 2. Make a dummy commit (e.g., add a new file or change)
+echo "Some feature work" > feature.txt  # Add a new file or make a change
+git add feature.txt  # Stage the file for commit
+git commit -m "Add feature.txt - dummy commit"  # Commit the changes
+
+# 3. Bump the version and automatically tag the release
+# (Bumpversion will handle both version bumping and tagging)
+bumpversion patch  # Bumps version, e.g., from v0.1.0 to v0.1.1 (adjust based on version part you want)
+
+# 4. Push the changes to remote (feature branch and the tag)
+git push origin feature/my-new-feature  # Push the feature branch
+git push origin --tags  # Push the new tag(s) created by bumpversion
+
+# 5. Open a pull request from the feature branch to the main branch
+# This can be done via GitHub UI, or using GitHub CLI
+gh pr create --base main --head feature/my-new-feature --title "New Feature" --body "This is a new feature that adds feature.txt."
+
+# 6. After the PR is accepted and merged, delete the feature branch locally and remotely
+git checkout main  # Switch back to main branch
+git pull origin main  # Ensure your main branch is up-to-date
+git branch -d feature/my-new-feature  # Delete the local feature branch
+git push origin --delete feature/my-new-feature  # Delete the remote feature branch
+
+```
+
 ## Notes
 
 #### New(er) Build System with `pyproject.toml` and `setup.cfg`
@@ -306,5 +369,6 @@ ssb   4096R/<KEY_SUBKEY_ID> 2024-11-22
 Contributions are very welcome!
 Please see the [contribution guidelines] or check out the [issues]
 
+
 ## License
 This software is released under the **[BSD 3-Clause License]**

{templatepy-0.2.0 → templatepy-0.2.3}/templatepy.egg-info/SOURCES.txt

@@ -1,3 +1,9 @@
+.bumpversion.cfg
+.gitignore
+.pre-commit-config.yaml
+.secrets.baseline
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
 LICENSE
 MANIFEST.in
 README.md
@@ -5,6 +11,7 @@ pyproject.toml
 setup.py
 templatepy/__init__.py
 templatepy/example.data.file.config
+templatepy/example.data.file.test-extension-yu48
 templatepy.egg-info/PKG-INFO
 templatepy.egg-info/SOURCES.txt
 templatepy.egg-info/dependency_links.txt

{templatepy-0.2.0 → templatepy-0.2.3}/templatepy.egg-info/requires.txt

@@ -6,3 +6,4 @@ bump2version
 pytest-cov
 pre-commit
 flake8
+toml

{templatepy-0.2.0 → templatepy-0.2.3}/templatepy.egg-info/top_level.txt

@@ -1,4 +1,2 @@
-build
-dist
 templatepy
 tests