From 7fc907ab2189d92de5eb712c8cfa8b69fb8b245d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 14 Jan 2026 01:33:05 +0000 Subject: [PATCH 1/2] Bump sphinx-toolbox from 4.0.0 to 4.1.1 Bumps [sphinx-toolbox](https://github.com/sphinx-toolbox/sphinx-toolbox) from 4.0.0 to 4.1.1. - [Release notes](https://github.com/sphinx-toolbox/sphinx-toolbox/releases) - [Changelog](https://github.com/sphinx-toolbox/sphinx-toolbox/blob/master/doc-source/changelog.rst) - [Commits](https://github.com/sphinx-toolbox/sphinx-toolbox/compare/v4.0.0...v4.1.1) --- updated-dependencies: - dependency-name: sphinx-toolbox dependency-version: 4.1.1 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- documentation-requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation-requirements.txt b/documentation-requirements.txt index 0811cd4..e9d76d3 100644 --- a/documentation-requirements.txt +++ b/documentation-requirements.txt @@ -7,7 +7,7 @@ sphinx-jinja2-compat==0.3.0 sphinx-prompt==1.9.0 sphinx-rtd-theme==3.0.2 sphinx-tabs==3.4.7 -sphinx-toolbox==4.0.0 +sphinx-toolbox==4.1.1 sphinxcontrib-applehelp==2.0.0 sphinxcontrib-devhelp==2.0.0 sphinxcontrib-htmlhelp==2.1.0 From f45f3fe3ec0b74ae46a26e3e801ce3e82d9010c8 Mon Sep 17 00:00:00 2001 From: docktermj Date: Wed, 14 Jan 2026 10:15:53 -0500 Subject: [PATCH 2/2] Update to template --- .claude/CLAUDE.md | 72 +++++++++++ .claude/commands/senzing-code-review.md | 3 - .claude/commands/senzing.md | 3 + .../{settings.local.json => settings.json} | 0 .github/CODEOWNERS | 2 +- .github/dependabot.yml | 16 ++- .../workflows/add-labels-standardized.yaml | 2 +- .../add-to-project-senzing-dependabot.yaml | 2 +- .github/workflows/add-to-project-senzing.yaml | 2 +- .github/workflows/claude-pr-review.yaml | 8 +- .../dependabot-approve-and-merge.yaml | 4 + .github/workflows/lint-workflows.yaml | 8 +- .../workflows/move-pr-to-done-dependabot.yaml | 2 +- .github/workflows/pylint.yaml | 17 ++- .github/workflows/spellcheck.yaml | 6 +- .vscode/cspell.json | 27 +++- CHANGELOG.md | 9 +- CODE_OF_CONDUCT.md | 103 +++++++++++---- CONTRIBUTING.md | 75 ++++++----- SECURITY.md | 21 ++++ development-requirements.txt | 18 --- documentation-requirements.txt | 18 --- pyproject.toml | 119 ++++++++++++++---- requirements.txt | 0 24 files changed, 379 insertions(+), 158 deletions(-) create mode 100644 .claude/CLAUDE.md delete mode 100644 .claude/commands/senzing-code-review.md create mode 100644 .claude/commands/senzing.md rename .claude/{settings.local.json => settings.json} (100%) create mode 100644 SECURITY.md delete mode 100644 development-requirements.txt delete mode 100644 documentation-requirements.txt delete mode 100644 requirements.txt diff --git a/.claude/CLAUDE.md b/.claude/CLAUDE.md new file mode 100644 index 0000000..1ac01ca --- /dev/null +++ b/.claude/CLAUDE.md @@ -0,0 +1,72 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Project Overview + +mapper-csv is a set of Python tools for mapping CSV files into JSON format for loading into Senzing entity resolution software. The tools analyze CSV files, generate column statistics, and produce either JSON mapping files or standalone Python mapper modules. + +## Commands + +### Install Dependencies + +```bash +python -m pip install --group all . +``` + +### Linting + +```bash +pylint $(git ls-files '*.py' ':!:docs/source/*') +``` + +### Run CSV Analyzer (generate Python module - recommended) + +```bash +python src/csv_analyzer.py -i input/file.csv -o output/analysis.csv -p mappings/file.py +``` + +### Run CSV Analyzer (generate mapping file) + +```bash +python src/csv_analyzer.py -i input/file.csv -o output/analysis.csv -m mappings/file.map +``` + +### Run CSV Mapper with mapping file + +```bash +python src/csv_mapper.py -i input/file.csv -m mappings/file.map -o output/file.json -l output/stats.json +``` + +### Run standalone Python mapper module + +```bash +python mappings/file.py -i input/file.csv -o output/file.json -l output/stats.json +``` + +## Architecture + +### Core Scripts (src/) + +- **csv_analyzer.py**: Analyzes CSV files to generate column statistics (percent populated, percent unique, top 5 values). Outputs either a JSON mapping file (`-m`) or a standalone Python mapper module (`-p`) based on `python_template.py`. + +- **csv_mapper.py**: Processes CSV files using either a JSON mapping file (`-m`) or a Python mapper module (`-p`) to produce Senzing-compatible JSON output. Supports calculations, filters, and attribute aggregation. + +- **csv_functions.py**: Utility class providing date formatting, value cleaning, and Senzing attribute detection. Loads configuration from `csv_functions.json` which defines garbage values and valid Senzing attributes. + +- **python_template.py**: Template used by csv_analyzer to generate standalone mapper modules. Contains the `mapper` class with methods for cleaning values, computing record hashes, formatting dates, and capturing statistics. + +### Mapping File Structure + +JSON mapping files have three sections: + +- **input**: File settings (inputFileName, fieldDelimiter, columnHeaders) +- **calculations**: Python expressions to create derived columns (e.g., `{"name_org": "rowData['name'] if rowData['type'] == 'company' else ''}`) +- **outputs**: Data source, record type, record ID, filters, and attribute mappings to Senzing attributes + +### Key Concepts + +- Senzing attributes (NAME_FULL, NAME_ORG, SSN_NUMBER, DATE_OF_BIRTH, ADDR_LINE1, etc.) are used for entity resolution +- Non-Senzing attributes are preserved but not used for matching +- The `` attribute tag excludes columns from output +- Calculations use `rowData['columnName']` syntax to reference column values diff --git a/.claude/commands/senzing-code-review.md b/.claude/commands/senzing-code-review.md deleted file mode 100644 index 7c1367b..0000000 --- a/.claude/commands/senzing-code-review.md +++ /dev/null @@ -1,3 +0,0 @@ -# Senzing code review - -- Perform the code review specified by diff --git a/.claude/commands/senzing.md b/.claude/commands/senzing.md new file mode 100644 index 0000000..d07dc3d --- /dev/null +++ b/.claude/commands/senzing.md @@ -0,0 +1,3 @@ +# Senzing + +- Perform the steps specified by diff --git a/.claude/settings.local.json b/.claude/settings.json similarity index 100% rename from .claude/settings.local.json rename to .claude/settings.json diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 13fdaef..2845f93 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,4 @@ - # Default code owner +# Default code owner * @Senzing/senzing-mappers diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5760d5b..9c5ea79 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -3,11 +3,15 @@ version: 2 updates: - - package-ecosystem: "github-actions" - directory: "/" + - package-ecosystem: github-actions + cooldown: + default-days: 21 + directory: / schedule: - interval: "daily" - - package-ecosystem: "pip" - directory: "/" + interval: daily + - package-ecosystem: pip + cooldown: + default-days: 21 + directory: / schedule: - interval: "daily" + interval: daily diff --git a/.github/workflows/add-labels-standardized.yaml b/.github/workflows/add-labels-standardized.yaml index 38b4e6f..e36297f 100644 --- a/.github/workflows/add-labels-standardized.yaml +++ b/.github/workflows/add-labels-standardized.yaml @@ -1,4 +1,4 @@ -name: add labels standardized +name: Add labels standardized on: issues: diff --git a/.github/workflows/add-to-project-senzing-dependabot.yaml b/.github/workflows/add-to-project-senzing-dependabot.yaml index 9b1a0e4..d8fa161 100644 --- a/.github/workflows/add-to-project-senzing-dependabot.yaml +++ b/.github/workflows/add-to-project-senzing-dependabot.yaml @@ -1,4 +1,4 @@ -name: add to project senzing github organization dependabot +name: Add to project senzing github organization dependabot on: pull_request: diff --git a/.github/workflows/add-to-project-senzing.yaml b/.github/workflows/add-to-project-senzing.yaml index 870bcca..6d67d89 100644 --- a/.github/workflows/add-to-project-senzing.yaml +++ b/.github/workflows/add-to-project-senzing.yaml @@ -1,4 +1,4 @@ -name: add to project senzing github organization +name: Add to project senzing github organization on: issues: diff --git a/.github/workflows/claude-pr-review.yaml b/.github/workflows/claude-pr-review.yaml index 46d00b7..dbd2bb1 100644 --- a/.github/workflows/claude-pr-review.yaml +++ b/.github/workflows/claude-pr-review.yaml @@ -1,13 +1,13 @@ name: Claude PR Review -concurrency: - group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }} - cancel-in-progress: true - on: pull_request: types: [opened, synchronize] +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }} + cancel-in-progress: true + permissions: {} jobs: diff --git a/.github/workflows/dependabot-approve-and-merge.yaml b/.github/workflows/dependabot-approve-and-merge.yaml index ecee237..c76218a 100644 --- a/.github/workflows/dependabot-approve-and-merge.yaml +++ b/.github/workflows/dependabot-approve-and-merge.yaml @@ -4,6 +4,10 @@ on: pull_request: branches: [main] +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }} + cancel-in-progress: true + permissions: {} jobs: diff --git a/.github/workflows/lint-workflows.yaml b/.github/workflows/lint-workflows.yaml index a119dda..ebd07bc 100644 --- a/.github/workflows/lint-workflows.yaml +++ b/.github/workflows/lint-workflows.yaml @@ -1,11 +1,13 @@ -name: lint workflows +name: Lint workflows on: - push: - branches-ignore: [main] pull_request: branches: [main] +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }} + cancel-in-progress: true + permissions: {} jobs: diff --git a/.github/workflows/move-pr-to-done-dependabot.yaml b/.github/workflows/move-pr-to-done-dependabot.yaml index d6cd67c..c2d2b66 100644 --- a/.github/workflows/move-pr-to-done-dependabot.yaml +++ b/.github/workflows/move-pr-to-done-dependabot.yaml @@ -1,4 +1,4 @@ -name: move pr to done dependabot +name: Move pr to done dependabot on: pull_request: diff --git a/.github/workflows/pylint.yaml b/.github/workflows/pylint.yaml index 1199115..38eae63 100644 --- a/.github/workflows/pylint.yaml +++ b/.github/workflows/pylint.yaml @@ -1,6 +1,12 @@ -name: pylint +name: Pylint -on: [push] +on: + pull_request: + branches: [main] + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }} + cancel-in-progress: true permissions: {} @@ -12,8 +18,10 @@ jobs: contents: read runs-on: ubuntu-latest strategy: + fail-fast: false matrix: - python-version: ["3.9", "3.10", "3.11", "3.12"] + python-version: ["3.10", "3.11", "3.12", "3.13"] + timeout-minutes: 10 steps: - name: Checkout repository @@ -32,8 +40,7 @@ jobs: source ./venv/bin/activate echo "PATH=${PATH}" >> "${GITHUB_ENV}" python -m pip install --upgrade pip - python -m pip install --requirement development-requirements.txt - python -m pip install --requirement requirements.txt + python -m pip install --group all . - name: Analysing the code with pylint run: | diff --git a/.github/workflows/spellcheck.yaml b/.github/workflows/spellcheck.yaml index a89ac8f..49f496a 100644 --- a/.github/workflows/spellcheck.yaml +++ b/.github/workflows/spellcheck.yaml @@ -1,9 +1,13 @@ -name: spellcheck +name: Spellcheck on: pull_request: branches: [main] +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }} + cancel-in-progress: true + permissions: {} jobs: diff --git a/.vscode/cspell.json b/.vscode/cspell.json index 30238ad..b78e93b 100644 --- a/.vscode/cspell.json +++ b/.vscode/cspell.json @@ -2,31 +2,48 @@ "version": "0.2", "language": "en", "words": [ + "analysing", + "applehelp", + "autodoc", + "autodocsumm", + "bugtracker", "CCLA", "CODEOWNER", - "DSRC", - "ICLA", - "Senzing", - "analysing", + "cooldown", "dateutil", + "devhelp", + "DSRC", "elif", "esbenp", + "htmlhelp", + "ICLA", "isort", + "jquery", + "jsmath", "kwargs", "mult", "mypy", "newcolumn", "probablepeople", + "psutil", "pydev", "pylint", "pytest", "pythonic", + "qthelp", + "remoteliteralinclude", + "Senzing", + "serializinghtml", "setuptools", "shellcheck", + "sphinxcontrib", + "sphinxext", "stackoverflow", "statpack", "subrecord", - "venv" + "typehints", + "venv", + "virtualenv" ], "ignorePaths": [ ".git/**", diff --git a/CHANGELOG.md b/CHANGELOG.md index 93b6169..5e9d666 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,8 @@ All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -[markdownlint](https://dlaa.me/markdownlint/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +The changelog format is based on [Keep a Changelog] and [CommonMark]. +This project adheres to [Semantic Versioning]. ## [Unreleased] @@ -27,3 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Thing 2 - Thing 1 + +[CommonMark]: https://commonmark.org/ +[Keep a Changelog]: https://keepachangelog.com/ +[Semantic Versioning]: https://semver.org/ diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index f6f9f91..086972c 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,46 +1,97 @@ -# Contributor Covenant Code of Conduct +# Contributor Covenant 3.0 Code of Conduct ## Our Pledge -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. +We pledge to make our community welcoming, safe, and equitable for all. -## Our Standards +We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, +regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, +sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, +socio-economic position, level of education, or other status. +The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant. -Examples of behavior that contributes to creating a positive environment include: +## Encouraged Behaviors -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. +We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language. -Examples of unacceptable behavior by participants include: +With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including: -* The use of sexualized language or imagery and unwelcome sexual attention or advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting +1. Respecting the **purpose of our community**, our activities, and our ways of gathering. +2. Engaging **kindly and honestly** with others. +3. Respecting **different viewpoints** and experiences. +4. **Taking responsibility** for our actions and contributions. +5. Gracefully giving and accepting **constructive feedback**. +6. Committing to **repairing harm** when it occurs. +7. Behaving in other ways that promote and sustain the **well-being of our community**. -## Our Responsibilities +## Restricted Behaviors -Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. +We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct. -Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. +1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop. +2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people. +3. **Stereotyping or discrimination.** Characterizing anyone's personality or behavior on the basis of immutable identities or traits. +4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community. +5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission. +6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group. +7. Behaving in other ways that **threaten the well-being** of our community. -## Scope +### Other Restrictions + +1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions. +2. **Failing to credit sources.** Not properly crediting the sources of content you contribute. +3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community. +4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors. + +## Reporting an Issue + +Tensions can occur between community members even when they are trying their best to collaborate. +Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm. + +When an incident does occur, it is important to report it promptly. +To report a possible violation, contact the project team at -This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. +Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. +They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. +Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. +In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution. -## Enforcement +## Addressing and Repairing Harm -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@senzing.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. +If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. +Depending on the severity of a violation, lower rungs on the ladder may be skipped. -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. +1. Warning + 1. Event: A violation involving a single incident or series of incidents. + 2. Consequence: A private, written warning from the Community Moderators. + 3. Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations. +2. Temporarily Limited Activities + 1. Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation. + 2. Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members. + 3. Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over. +3. Temporary Suspension + 1. Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation. + 2. Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions. + 3. Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted. +4. Permanent Ban + 1. Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member. + 2. Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior. + 3. Repair: There is no possible repair in cases of this severity. + +This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. +Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] +This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/). + +Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/) -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ +For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). +Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). +The enforcement ladder was inspired by the work of [Mozilla's code of conduct team](https://github.com/mozilla/inclusion). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7960d70..fe4d57c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,56 +2,47 @@ Welcome to the project! -We encourage contribution in a manner consistent with the [Code of Conduct](CODE_OF_CONDUCT.md). +We encourage contribution in a manner consistent with the [Code of Conduct]. The following will guide you through the process. There are a number of ways you can contribute: -1. [Asking questions](#questions) -1. [Requesting features](#feature-requests) -1. [Reporting bugs](#bug-reporting) -1. [Contributing code or documentation](#contributing-code-or-documentation) +1. [Asking questions] +1. [Requesting features] +1. [Reporting bugs] +1. [Contributing code or documentation] ## License Agreements -If your contribution modifies the git repository, the following agreements must be established. +If your contribution modifies the Git repository, the following agreements must be established. -*Note:* License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository. +_Note:_ License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository. In simple terms, license agreements are needed before pull requests can be accepted. A license agreement is not needed for submitting feature request, bug reporting, or other project management. ### Individual Contributor License Agreement -In order to contribute to this repository, an -[Individual Contributor License Agreement (ICLA)](.github/senzing-individual-contributor-license-agreement.pdf) -must be completed, submitted and accepted. +In order to contribute to this repository, an [Individual Contributor License Agreement (ICLA)] must be completed, submitted, and accepted. ### Corporate Contributor License Agreement -If the contribution to this repository is on behalf of a company, a -[Corporate Contributor License Agreement (CCLA)](.github/senzing-corporate-contributor-license-agreement.pdf) -must also be completed, submitted and accepted. +If the contribution to this repository is on behalf of a company, a [Corporate Contributor License Agreement (CCLA)] must also be completed, submitted, and accepted. ### Project License Agreement -The license agreement for this repository is stated in the -[LICENSE](LICENSE) file. +The license agreement for this repository is stated in the [LICENSE] file. ## Questions Please do not use the GitHub issue tracker to submit questions. -TODO: Instead, use ??? - -1. ??? Slack ??? -1. ??? stackoverflow.com ??? +Instead, email . +For open discussions, use GitHub's [Discussions]. ## Feature Requests All feature requests are "GitHub issues". -To request a feature, create a -[GitHub issue](https://help.github.com/articles/creating-an-issue/) -in this repository. +To request a feature, create a [GitHub issue] in this repository. When creating an issue, there will be a choice to create a "Bug report" or a "Feature request". Choose "Feature request". @@ -59,20 +50,16 @@ Choose "Feature request". ## Bug Reporting All bug reports are "GitHub issues". -Before reporting on a bug, check to see if it has -[already been reported](https://github.com/search?q=+is%3Aissue+user%3Asenzing). -To report a bug, create a -[GitHub issue](https://help.github.com/articles/creating-an-issue/) -in this repository. +Before reporting on a bug, check to see if it has [already been reported]. +To report a bug, create a [GitHub issue] in this repository. When creating an issue, there will be a choice to create a "Bug report" or a "Feature request". Choose "Bug report". ## Contributing code or documentation -To contribute code or documentation to the repository, you must have -[License Agreements](#license-agreements) in place. -This needs to be complete before a [Pull Request](#pull-requests) can be accepted. +To contribute code or documentation to the repository, you must have [License Agreements] in place. +This needs to be complete before a [Pull Request] can be accepted. ### Setting up a development environment @@ -83,7 +70,7 @@ The variables are used throughout the installation procedure. ```console export GIT_ACCOUNT=senzing -export GIT_REPOSITORY=poc-csv-tools +export GIT_REPOSITORY=mapper-csv ``` Synthesize environment variables. @@ -107,18 +94,28 @@ cd ${GIT_REPOSITORY_DIR} ### Coding conventions -TODO: - ### Testing -TODO: - ### Pull Requests Code in the main branch is modified via GitHub pull request. -Follow GitHub's -[Creating a pull request from a branch](https://help.github.com/articles/creating-a-pull-request/) -or -[Creating a pull request from a fork](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) instructions. +Follow GitHub's [Creating a pull request from a branch] or +[Creating a pull request from a fork] instructions. Accepting pull requests will be at the discretion of Senzing, Inc. and the repository owner(s). + +[already been reported]: https://github.com/search?q=+is%3Aissue+user%3Asenzing +[Asking questions]: #questions +[Code of Conduct]: CODE_OF_CONDUCT.md +[Contributing code or documentation]: #contributing-code-or-documentation +[Corporate Contributor License Agreement (CCLA)]: .github/senzing-corporate-contributor-license-agreement.pdf +[Creating a pull request from a branch]: https://help.github.com/articles/creating-a-pull-request/ +[Creating a pull request from a fork]: https://help.github.com/articles/creating-a-pull-request-from-a-fork/ +[Discussions]: https://github.com/senzing-garage/mapper-csv/discussions +[GitHub issue]: https://help.github.com/articles/creating-an-issue/ +[Individual Contributor License Agreement (ICLA)]: .github/senzing-individual-contributor-license-agreement.pdf +[License Agreements]: #license-agreements +[LICENSE]: LICENSE +[Pull Request]: #pull-requests +[Reporting bugs]: #bug-reporting +[Requesting features]: #feature-requests diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..4ce4936 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,21 @@ +# Security Policy + +## Supported Versions + +The following versions of this repository are supported with security updates. + +| Version | Supported | +| ------- | :----------------: | +| 0.0.x | :white_check_mark: | +| < 0.0 | :x: | + +## Reporting a Vulnerability + +If you believe you have found a security vulnerability in this repository, +please open it privately via the [Report a security vulnerability] link in the Security tab. + +**Please do not report security vulnerabilities through public issues, discussions, or pull requests.** + +In general, project dependencies are updated within 60 days of the dependency's release. + +[Report a security vulnerability]: https://github.com/senzing-garage/template-python/security/advisories/new diff --git a/development-requirements.txt b/development-requirements.txt deleted file mode 100644 index 095ace4..0000000 --- a/development-requirements.txt +++ /dev/null @@ -1,18 +0,0 @@ -bandit==1.8.5 -black==25.1.0 -build==1.2.2.post1 -coverage==7.9.2 -cryptography==45.0.4 -flake8==7.2.0 -fpvs==0.3.0 -isort==6.0.1 -mypy==1.16.1 -psutil==7.0.0 -pylint-per-file-ignores==1.4.0 -pylint==3.3.7 -pytest-cov==6.2.1 -pytest-schema==0.1.2 -pytest==8.4.1 -twine==6.1.0 -virtualenv==20.31.2 -wheel==0.46.1 diff --git a/documentation-requirements.txt b/documentation-requirements.txt deleted file mode 100644 index e9d76d3..0000000 --- a/documentation-requirements.txt +++ /dev/null @@ -1,18 +0,0 @@ -autodocsumm==0.2.14 -myst_parser==4.0.1 -sphinx -sphinx-autodoc-typehints==3.1.0 -sphinx-gallery==0.19.0 -sphinx-jinja2-compat==0.3.0 -sphinx-prompt==1.9.0 -sphinx-rtd-theme==3.0.2 -sphinx-tabs==3.4.7 -sphinx-toolbox==4.1.1 -sphinxcontrib-applehelp==2.0.0 -sphinxcontrib-devhelp==2.0.0 -sphinxcontrib-htmlhelp==2.1.0 -sphinxcontrib-jquery==4.1 -sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==2.0.0 -sphinxcontrib-serializinghtml==2.0.0 -sphinxext-remoteliteralinclude==0.6.0 diff --git a/pyproject.toml b/pyproject.toml index 9f4fd38..59c6a51 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,12 +1,94 @@ -[build-system] -requires = [ - "setuptools>=42", - "wheel" +[project] +name = "mapper-csv" +version = "0.0.1" +description = "mapper-csv" +authors = [{ name = "senzing", email = "support@senzing.com" }] +readme = "README.md" +requires-python = ">=3.10" +classifiers = [ + "Programming Language :: Python :: 3", + "Operating System :: OS Independent", +] +license = "Apache-2.0" +license-files = [ + "LICENSE", + ".github/senzing-corporate-contributor-license-agreement.pdf", + ".github/senzing-individual-contributor-license-agreement.pdf", ] + +[project.urls] +bugtracker = "https://github.com/senzing/mapper-csv/issues" +changelog = "https://github.com/senzing/mapper-csv/blob/main/CHANGELOG.md" +source = "https://github.com/senzing/mapper-csv" + +[build-system] +requires = ["setuptools>=80", "wheel"] build-backend = "setuptools.build_meta" [dependency-groups] -test = ["pytest", "coverage"] +all = [ + { include-group = "development" }, + { include-group = "documentation" }, + { include-group = "lint" }, + { include-group = "test" }, +] +development = [ + "build==1.3.0", + "coverage==7.10.7; python_version <= '3.11'", + "coverage==7.13.1; python_version > '3.11'", + "cryptography==46.0.3", + "psutil==7.2.1", + "pytest-cov==7.0.0", + "pytest-schema==0.1.2", + "pytest==8.4.2; python_version <= '3.11'", + "pytest==9.0.2; python_version > '3.11'", + "twine==6.2.0", + "virtualenv==20.36.1", + "wheel==0.45.1", +] +documentation = [ + "autodocsumm", + "myst_parser", + "sphinx-autodoc-typehints", + "sphinx-gallery", + "sphinx-jinja2-compat", + "sphinx-prompt", + "sphinx-rtd-theme", + "sphinx-tabs", + "sphinx-toolbox", + "sphinx", + "sphinxcontrib-applehelp", + "sphinxcontrib-devhelp", + "sphinxcontrib-htmlhelp", + "sphinxcontrib-jquery", + "sphinxcontrib-jsmath", + "sphinxcontrib-qthelp", + "sphinxcontrib-serializinghtml", + "sphinxext-remoteliteralinclude", +] +lint = [ + "bandit==1.8.6; python_version <= '3.11'", + "bandit==1.9.2; python_version > '3.11'", + "black==25.11.0; python_version <= '3.11'", + "black==25.12.0; python_version > '3.11'", + "flake8==7.3.0", + "isort==6.1.0; python_version <= '3.11'", + "isort==7.0.0; python_version > '3.11'", + "mypy==1.19.1", + "pylint-per-file-ignores==2.0.3; python_version <= '3.11'", + "pylint-per-file-ignores==3.2.0; python_version > '3.11'", + "pylint==3.3.9; python_version <= '3.11'", + "pylint==4.0.4; python_version > '3.11'", +] +test = [ + "pytest==8.4.2; python_version <= '3.11'", + "pytest==9.0.2; python_version > '3.11'", + "coverage==7.10.7; python_version <= '3.11'", + "coverage==7.13.1; python_version > '3.11'", +] + +[tool.setuptools.packages.find] +where = ["src"] [tool.bandit] skips = ["B101"] @@ -25,21 +107,14 @@ src_paths = ["examples", "src", "tests"] [tool.pylint] ignored-argument-names = "args|kwargs" disable = [ - "consider-using-with", - "invalid-name", - "line-too-long", - "too-many-branches", - "too-many-lines", - "too-many-statements", - "unspecified-encoding", -] -good-names = [ - "mapper-equifax" -] -ignore = [ - "__init__.py", - "docs/source/conf.py" -] -notes = [ - "FIXME" + "consider-using-with", + "invalid-name", + "line-too-long", + "too-many-branches", + "too-many-lines", + "too-many-statements", + "unspecified-encoding", ] +good-names = ["mapper-csv"] +ignore = ["__init__.py", "docs/source/conf.py"] +notes = ["FIXME"] diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index e69de29..0000000