my-package-test-0426 0.4.1

This package helps normalize strings.

What this repository contains

1. READMEs templates to choose
2. Package setup via pyproject (uv recommended)
3. Repository prepared for collaboration: CODE_OF_CONDUCT, CONTRIBUTING, CODEOWNERS
4. Documentation set-up via mkdocs
5. Pre-commit and CI gates in ./github/workflows
6. VsCode settings

How To Use This Template

1. Click green button "Use This Template" on the right upper corner of this repo.

2. Fill next form with Your data.

3. Choose the README style — either for public presence or internal.

   • Public is more suited for packages.
   • Remove the unused README
   • Change the name of the readme that you have chosen to README.MD so that it's the main file.

4. Run repo_polcy.sh from the root folder. This Bash script enforces a standardized security and branch-protection policy using JSON specs that ara applied using Github Rest API. Concretely it:

   • Repository settings: Advanced Security, Code scanning, Secret scanning, secret scanning push protection from repo-security.json
   • Enables Dependabot vulnerability alerts
   • Enables the dependency graph
   • Enables Dependabot automated security fixes
   • Configures CodeQL default code scanning from codeql-default-setup.json
   • Applies branch protection rules to the target branch from branch-protection.json

   Usage: apply-repo-policy.sh -o OWNER -r REPO [-b BRANCH] [-t TOKEN]

   Options:

   • -o GitHub org/user (owner)
   • -r Repository name
   • -b Branch to protect (default: repo default branch)
   • -t Token (optional if GITHUB_TOKEN is set)
   • -h Show help

   Note: you can set env variable GITHUB_TOKEN and skip it as an argument.

5. Update the link — [docs/rfc](https://github.com/ORG/REPO/tree/main/docs/rfc) — in .github/ISSUE_TEMPLATE/design_rfc.yml

6. Update the name of the package in src/my_package_test_0426/, docs/reference/my_package_test_0426.md, and docs/reference/index.md

7. Update pyproject.toml with the information of your package.

8. Adjust Ruff Settings in pyproject.toml

9. Remove this README.md