From 8db8a92c1cea93a77e84b4dfcf2b5953a5d0c540 Mon Sep 17 00:00:00 2001 From: Sam <109683132+kernelsam@users.noreply.github.com> Date: Fri, 26 Jan 2024 18:52:07 -0800 Subject: [PATCH] #171 Migrate repository (#174) --- .github/CODEOWNERS | 6 +-- .github/ISSUE_TEMPLATE/bug_report.md | 38 ------------------- .../ISSUE_TEMPLATE/documentation_request.md | 26 ------------- .github/ISSUE_TEMPLATE/feature_request.md | 17 --------- .../workflows/add-to-project-g2-python.yaml | 22 +++++------ PULL_REQUEST_TEMPLATE.md | 13 ------- README.md | 28 ++++++++++---- setup.cfg | 4 +- src/senzing/G2Config.py | 2 +- src/senzing/G2ConfigMgr.py | 2 +- src/senzing/G2Diagnostic.py | 2 +- src/senzing/G2Engine.py | 2 +- src/senzing/G2Exception.py | 2 +- src/senzing/G2Hasher.py | 2 +- src/senzing/G2Product.py | 2 +- 15 files changed, 41 insertions(+), 127 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/documentation_request.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 72b09d9..28f9136 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,5 +1,5 @@ - # Default code owner +# Default code owner -* @Senzing/g2-python +* @senzing-garage/senzing-g2-python-developers -/.github/ @Senzing/senzing-devsecops +/.github/ @senzing-garage/senzing-devsecops diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d3a80d7..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - -- OS: [e.g. iOS] -- Browser [e.g. chrome, safari] -- Version [e.g. 22] - -**Smartphone (please complete the following information):** - -- Device: [e.g. iPhone6] -- OS: [e.g. iOS8.1] -- Browser [e.g. stock browser, safari] -- Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation_request.md b/.github/ISSUE_TEMPLATE/documentation_request.md deleted file mode 100644 index c18a3fa..0000000 --- a/.github/ISSUE_TEMPLATE/documentation_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Documentation request -about: Identify an area for improvement in documentation - ---- - -**What is the URL of the documentation?** - -- **Example:** https://github.com/Senzing/template-docker#external-database - - *Note:* This URL includes the web page and the section of the documentation. - -**What can be improved?** - -A clear and concise description of what can be improved. -Examples: - -- "I don't understand where the ${XYZ} variable is set." -- "There seems to be a step missing between 'X' and 'Z'. I don't know how to get to 'Z'." -- "When I run `command sub-command ...` I get the following error:" -- "I don't know what is meant by 'gerble barb gazoink` in the instructions". - -**Additional context** - -Add any other context or screenshots to help describe the documentation improvement. -If you think the documentation improvement is operating system specific, -please indicate which operating system is being used. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 066b2d9..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**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. diff --git a/.github/workflows/add-to-project-g2-python.yaml b/.github/workflows/add-to-project-g2-python.yaml index 3b3e1ce..e50cf6d 100644 --- a/.github/workflows/add-to-project-g2-python.yaml +++ b/.github/workflows/add-to-project-g2-python.yaml @@ -1,22 +1,18 @@ -# Based on -# - https://github.com/srggrs/assign-one-project-github-action - -name: Auto Assign issue to project +name: 'add to project g2 python' on: issues: types: - - reopened - opened -env: - GITHUB_TOKEN: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }} + - reopened jobs: - assign_one_project: + add-to-project: + name: Add issue to project runs-on: ubuntu-latest steps: - - name: Assign issues to project - uses: Senzing/github-action-add-issue-to-project@main - with: - project: 'https://github.com/orgs/Senzing/projects/8' - column_name: 'Backlog' + - name: Assign issue to project + uses: actions/add-to-project@v0.5.0 + with: + project-url: https://github.com/orgs/${{ vars.SENZING_GITHUB_ACCOUNT_NAME }}/projects/${{ vars.SENZING_PROJECT_G2_PYTHON }} + github-token: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }} diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0b11a2f..0000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,13 +0,0 @@ -# Pull request questions - -## Which issue does this address - -Issue number: #nnn - -## Why was change needed - -??? - -## What does change improve - -??? diff --git a/README.md b/README.md index 13564e8..5011e4a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # g2-sdk-python +If you are beginning your journey with +[Senzing](https://senzing.com/), +please start with +[Senzing Quick Start guides](https://docs.senzing.com/quickstart/). + +You are in the +[Senzing Garage](https://github.com/senzing-garage) +where projects are "tinkered" on. +Although this GitHub repository may help you understand an approach to using Senzing, +it's not considered to be "production ready" and is not considered to be part of the Senzing product. +Heck, it may not even be appropriate for your application of Senzing! + ## Synopsis Senzing Software Development Kit (SDK) for Python. @@ -12,12 +24,12 @@ To obtain a version of the Senzing Python SDK that *is* covered, see [Install Senzing API](https://hub.senzing.com/knowledge-base/senzingapi/install). More information at -[github.com/Senzing/g2-sdk-python](https://github.com/Senzing/g2-sdk-python) +[github.com/senzing-garage/g2-sdk-python](https://github.com/senzing-garage/g2-sdk-python) ## Overview The git repository at -[github.com/Senzing/g2-sdk-python](https://github.com/Senzing/g2-sdk-python) +[github.com/senzing-garage/g2-sdk-python](https://github.com/senzing-garage/g2-sdk-python) contains the Senzing SDK for Python files in `src/senzing`. It also contains: @@ -53,7 +65,7 @@ It also contains: ``` 1. More information at - [github.com/Senzing/g2-sdk-python](https://github.com/Senzing/g2-sdk-python) + [github.com/senzing-garage/g2-sdk-python](https://github.com/senzing-garage/g2-sdk-python) ## Develop @@ -65,9 +77,9 @@ The following instructions are used when modifying and building the Docker image These are "one-time tasks" which may already have been completed. 1. The following software programs need to be installed: - 1. [git](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/git.md) - 1. [make](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/make.md) - 1. [pip](https://github.com/Senzing/knowledge-base/blob/main/HOWTO/install-pip.md) + 1. [git](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/git.md) + 1. [make](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/make.md) + 1. [pip](https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/install-pip.md) 1. :pencil2: Make a `~/.pypirc` file. Example: @@ -85,7 +97,7 @@ These are "one-time tasks" which may already have been completed. ### Clone repository For more information on environment variables, -see [Environment Variables](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md). +see [Environment Variables](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md). 1. Set these environment variable values: @@ -96,7 +108,7 @@ see [Environment Variables](https://github.com/Senzing/knowledge-base/blob/main/ export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}" ``` -1. Using the environment variables values just set, follow steps in [clone-repository](https://github.com/Senzing/knowledge-base/blob/main/HOWTO/clone-repository.md) to install the Git repository. +1. Using the environment variables values just set, follow steps in [clone-repository](https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/clone-repository.md) to install the Git repository. ### Install dependencies diff --git a/setup.cfg b/setup.cfg index 051c546..4f5b221 100644 --- a/setup.cfg +++ b/setup.cfg @@ -7,9 +7,9 @@ description = Python SDK for Senzing API license = Apache 2 long_description = file: README.md long_description_content_type = text/markdown -url = https://github.com/Senzing/g2-sdk-python +url = https://github.com/senzing-garage/g2-sdk-python project_urls = - Bug Tracker = https://github.com/Senzing/g2-sdk-python/issues + Bug Tracker = https://github.com/senzing-garage/g2-sdk-python/issues classifiers = Programming Language :: Python :: 3 License :: OSI Approved :: Apache Software License diff --git a/src/senzing/G2Config.py b/src/senzing/G2Config.py index ae07c46..5668f8c 100644 --- a/src/senzing/G2Config.py +++ b/src/senzing/G2Config.py @@ -7,7 +7,7 @@ from .G2Exception import TranslateG2ModuleException, G2NotInitializedException, G2Exception __all__ = ['G2Config'] -SENZING_PRODUCT_ID = "5040" # See https://github.com/Senzing/knowledge-base/blob/main/lists/senzing-component-ids.md +SENZING_PRODUCT_ID = "5040" # See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-component-ids.md class MyBuffer(threading.local): diff --git a/src/senzing/G2ConfigMgr.py b/src/senzing/G2ConfigMgr.py index 62258a4..297781b 100644 --- a/src/senzing/G2ConfigMgr.py +++ b/src/senzing/G2ConfigMgr.py @@ -7,7 +7,7 @@ from .G2Exception import TranslateG2ModuleException, G2NotInitializedException, G2Exception __all__ = ['G2ConfigMgr'] -SENZING_PRODUCT_ID = "5041" # See https://github.com/Senzing/knowledge-base/blob/main/lists/senzing-component-ids.md +SENZING_PRODUCT_ID = "5041" # See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-component-ids.md class MyBuffer(threading.local): diff --git a/src/senzing/G2Diagnostic.py b/src/senzing/G2Diagnostic.py index 5e633e8..be47739 100644 --- a/src/senzing/G2Diagnostic.py +++ b/src/senzing/G2Diagnostic.py @@ -7,7 +7,7 @@ from .G2Exception import TranslateG2ModuleException, G2NotInitializedException, G2Exception __all__ = ['G2Diagnostic'] -SENZING_PRODUCT_ID = "5042" # See https://github.com/Senzing/knowledge-base/blob/main/lists/senzing-component-ids.md +SENZING_PRODUCT_ID = "5042" # See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-component-ids.md class MyBuffer(threading.local): diff --git a/src/senzing/G2Engine.py b/src/senzing/G2Engine.py index b715fcb..5830755 100644 --- a/src/senzing/G2Engine.py +++ b/src/senzing/G2Engine.py @@ -9,7 +9,7 @@ from .G2EngineFlags import G2EngineFlags __all__ = ['G2Engine'] -SENZING_PRODUCT_ID = "5043" # See https://github.com/Senzing/knowledge-base/blob/main/lists/senzing-component-ids.md +SENZING_PRODUCT_ID = "5043" # See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-component-ids.md class MyBuffer(threading.local): diff --git a/src/senzing/G2Exception.py b/src/senzing/G2Exception.py index 4569386..14ab818 100644 --- a/src/senzing/G2Exception.py +++ b/src/senzing/G2Exception.py @@ -19,7 +19,7 @@ "TranslateG2ModuleException", ] -# See https://github.com/Senzing/knowledge-base/blob/main/lists/senzing-component-ids.md +# See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-component-ids.md SENZING_PRODUCT_ID = "5044" # ----------------------------------------------------------------------------- diff --git a/src/senzing/G2Hasher.py b/src/senzing/G2Hasher.py index b355be3..d11a8a6 100644 --- a/src/senzing/G2Hasher.py +++ b/src/senzing/G2Hasher.py @@ -7,7 +7,7 @@ from .G2Exception import TranslateG2ModuleException, G2NotInitializedException, G2Exception __all__ = ['G2Hasher'] -SENZING_PRODUCT_ID = "5045" # See https://github.com/Senzing/knowledge-base/blob/main/lists/senzing-component-ids.md +SENZING_PRODUCT_ID = "5045" # See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-component-ids.md class MyBuffer(threading.local): diff --git a/src/senzing/G2Product.py b/src/senzing/G2Product.py index 4b6307a..543621e 100644 --- a/src/senzing/G2Product.py +++ b/src/senzing/G2Product.py @@ -7,7 +7,7 @@ from .G2Exception import TranslateG2ModuleException, G2NotInitializedException, G2Exception __all__ = ['G2Product'] -SENZING_PRODUCT_ID = "5046" # See https://github.com/Senzing/knowledge-base/blob/main/lists/senzing-component-ids.md +SENZING_PRODUCT_ID = "5046" # See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-component-ids.md class MyBuffer(threading.local):