opengris-parfun 7.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- opengris_parfun-7.3.0/.github/dependabot.yml +11 -0
- opengris_parfun-7.3.0/.github/workflows/codeql.yml +48 -0
- opengris_parfun-7.3.0/.github/workflows/dependency-review.yml +25 -0
- opengris_parfun-7.3.0/.github/workflows/documentation.yml +46 -0
- opengris_parfun-7.3.0/.github/workflows/linter.yml +57 -0
- opengris_parfun-7.3.0/.github/workflows/pypi.yml +38 -0
- opengris_parfun-7.3.0/.github/workflows/scorecard.yml +58 -0
- opengris_parfun-7.3.0/.gitignore +21 -0
- opengris_parfun-7.3.0/CONTRIBUTING.md +102 -0
- opengris_parfun-7.3.0/LICENSE +201 -0
- opengris_parfun-7.3.0/LICENSE.spdx +7 -0
- opengris_parfun-7.3.0/NOTICE +7 -0
- opengris_parfun-7.3.0/PKG-INFO +165 -0
- opengris_parfun-7.3.0/README.md +135 -0
- opengris_parfun-7.3.0/docs/.gitignore +1 -0
- opengris_parfun-7.3.0/docs/Makefile +20 -0
- opengris_parfun-7.3.0/docs/make.bat +35 -0
- opengris_parfun-7.3.0/docs/requirements.txt +6 -0
- opengris_parfun-7.3.0/docs/source/_templates/layout.html +11 -0
- opengris_parfun-7.3.0/docs/source/api.rst +66 -0
- opengris_parfun-7.3.0/docs/source/conf.py +63 -0
- opengris_parfun-7.3.0/docs/source/index.rst +32 -0
- opengris_parfun-7.3.0/docs/source/tutorials/examples.rst +98 -0
- opengris_parfun-7.3.0/docs/source/tutorials/images/parallel_function.png +0 -0
- opengris_parfun-7.3.0/docs/source/tutorials/images/parallel_scatter_gather.png +0 -0
- opengris_parfun-7.3.0/docs/source/tutorials/images/partition_size_estimator_graph_1.png +0 -0
- opengris_parfun-7.3.0/docs/source/tutorials/images/partition_size_estimator_graph_2.png +0 -0
- opengris_parfun-7.3.0/docs/source/tutorials/implementation_details.rst +65 -0
- opengris_parfun-7.3.0/docs/source/tutorials/quickstart.rst +260 -0
- opengris_parfun-7.3.0/examples/__init__.py +0 -0
- opengris_parfun-7.3.0/examples/api_usage/__init__.py +0 -0
- opengris_parfun-7.3.0/examples/api_usage/all_arguments.py +49 -0
- opengris_parfun-7.3.0/examples/api_usage/backend_setup.py +19 -0
- opengris_parfun-7.3.0/examples/api_usage/custom_generators.py +68 -0
- opengris_parfun-7.3.0/examples/api_usage/nested_functions.py +51 -0
- opengris_parfun-7.3.0/examples/api_usage/partition_size.py +57 -0
- opengris_parfun-7.3.0/examples/api_usage/per_argument.py +44 -0
- opengris_parfun-7.3.0/examples/api_usage/profiling.py +31 -0
- opengris_parfun-7.3.0/examples/california_housing/__init__.py +0 -0
- opengris_parfun-7.3.0/examples/california_housing/main.py +79 -0
- opengris_parfun-7.3.0/examples/count_bigrams/__init__.py +0 -0
- opengris_parfun-7.3.0/examples/count_bigrams/main.py +55 -0
- opengris_parfun-7.3.0/examples/europe_electricity/__init__.py +0 -0
- opengris_parfun-7.3.0/examples/europe_electricity/main.py +168 -0
- opengris_parfun-7.3.0/examples/portfolio_metrics/__init__.py +0 -0
- opengris_parfun-7.3.0/examples/portfolio_metrics/main.py +56 -0
- opengris_parfun-7.3.0/examples/requirements.txt +1 -0
- opengris_parfun-7.3.0/images/benchmark_results.svg +52 -0
- opengris_parfun-7.3.0/opengris_parfun.egg-info/PKG-INFO +165 -0
- opengris_parfun-7.3.0/opengris_parfun.egg-info/SOURCES.txt +119 -0
- opengris_parfun-7.3.0/opengris_parfun.egg-info/dependency_links.txt +1 -0
- opengris_parfun-7.3.0/opengris_parfun.egg-info/requires.txt +13 -0
- opengris_parfun-7.3.0/opengris_parfun.egg-info/top_level.txt +1 -0
- opengris_parfun-7.3.0/parfun/__init__.py +26 -0
- opengris_parfun-7.3.0/parfun/about.py +1 -0
- opengris_parfun-7.3.0/parfun/backend/__init__.py +0 -0
- opengris_parfun-7.3.0/parfun/backend/dask.py +151 -0
- opengris_parfun-7.3.0/parfun/backend/local_multiprocessing.py +92 -0
- opengris_parfun-7.3.0/parfun/backend/local_single_process.py +47 -0
- opengris_parfun-7.3.0/parfun/backend/mixins.py +68 -0
- opengris_parfun-7.3.0/parfun/backend/profiled_future.py +50 -0
- opengris_parfun-7.3.0/parfun/backend/scaler.py +226 -0
- opengris_parfun-7.3.0/parfun/backend/utility.py +7 -0
- opengris_parfun-7.3.0/parfun/combine/__init__.py +0 -0
- opengris_parfun-7.3.0/parfun/combine/collection.py +13 -0
- opengris_parfun-7.3.0/parfun/combine/dataframe.py +13 -0
- opengris_parfun-7.3.0/parfun/dataframe.py +175 -0
- opengris_parfun-7.3.0/parfun/decorators.py +135 -0
- opengris_parfun-7.3.0/parfun/entry_point.py +180 -0
- opengris_parfun-7.3.0/parfun/functions.py +71 -0
- opengris_parfun-7.3.0/parfun/kernel/__init__.py +0 -0
- opengris_parfun-7.3.0/parfun/kernel/function_signature.py +197 -0
- opengris_parfun-7.3.0/parfun/kernel/parallel_function.py +262 -0
- opengris_parfun-7.3.0/parfun/object.py +7 -0
- opengris_parfun-7.3.0/parfun/partition/__init__.py +0 -0
- opengris_parfun-7.3.0/parfun/partition/api.py +136 -0
- opengris_parfun-7.3.0/parfun/partition/collection.py +13 -0
- opengris_parfun-7.3.0/parfun/partition/dataframe.py +16 -0
- opengris_parfun-7.3.0/parfun/partition/object.py +50 -0
- opengris_parfun-7.3.0/parfun/partition/primitives.py +317 -0
- opengris_parfun-7.3.0/parfun/partition/utility.py +54 -0
- opengris_parfun-7.3.0/parfun/partition_size_estimator/__init__.py +0 -0
- opengris_parfun-7.3.0/parfun/partition_size_estimator/linear_regression_estimator.py +189 -0
- opengris_parfun-7.3.0/parfun/partition_size_estimator/mixins.py +22 -0
- opengris_parfun-7.3.0/parfun/partition_size_estimator/object.py +19 -0
- opengris_parfun-7.3.0/parfun/profiler/__init__.py +0 -0
- opengris_parfun-7.3.0/parfun/profiler/functions.py +261 -0
- opengris_parfun-7.3.0/parfun/profiler/object.py +68 -0
- opengris_parfun-7.3.0/parfun/py_list.py +56 -0
- opengris_parfun-7.3.0/pyproject.toml +57 -0
- opengris_parfun-7.3.0/renovate.json +22 -0
- opengris_parfun-7.3.0/requirements.txt +3 -0
- opengris_parfun-7.3.0/setup.cfg +4 -0
- Scaler: Implicit Parallelization Libraries.pdf +0 -0
- opengris_parfun-7.3.0/slides/readme.txt +1 -0
- opengris_parfun-7.3.0/tests/__init__.py +0 -0
- opengris_parfun-7.3.0/tests/backend/__init__.py +0 -0
- opengris_parfun-7.3.0/tests/backend/mixins.py +177 -0
- opengris_parfun-7.3.0/tests/backend/test_dask.py +39 -0
- opengris_parfun-7.3.0/tests/backend/test_local_multiprocessing.py +26 -0
- opengris_parfun-7.3.0/tests/backend/test_local_single_process.py +19 -0
- opengris_parfun-7.3.0/tests/backend/test_scaler.py +40 -0
- opengris_parfun-7.3.0/tests/backend/utility.py +41 -0
- opengris_parfun-7.3.0/tests/kernel/__init__.py +0 -0
- opengris_parfun-7.3.0/tests/kernel/test_function_signature.py +52 -0
- opengris_parfun-7.3.0/tests/kernel/test_parallel_function.py +30 -0
- opengris_parfun-7.3.0/tests/partition/__init__.py +0 -0
- opengris_parfun-7.3.0/tests/partition/test_api.py +104 -0
- opengris_parfun-7.3.0/tests/partition/test_primitives.py +108 -0
- opengris_parfun-7.3.0/tests/partition/test_utility.py +17 -0
- opengris_parfun-7.3.0/tests/partition_size_estimator/__init__.py +0 -0
- opengris_parfun-7.3.0/tests/partition_size_estimator/test_linear_regression_estimator.py +80 -0
- opengris_parfun-7.3.0/tests/profiler/__init__.py +0 -0
- opengris_parfun-7.3.0/tests/profiler/test_functions.py +22 -0
- opengris_parfun-7.3.0/tests/test_collection.py +14 -0
- opengris_parfun-7.3.0/tests/test_context.py +23 -0
- opengris_parfun-7.3.0/tests/test_dataframe.py +92 -0
- opengris_parfun-7.3.0/tests/test_decorators.py +290 -0
- opengris_parfun-7.3.0/tests/test_functions.py +73 -0
- opengris_parfun-7.3.0/tests/test_helpers.py +29 -0
- opengris_parfun-7.3.0/tests/test_legacy_api.py +66 -0
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# To get started with Dependabot version updates, you'll need to specify which
|
|
2
|
+
# package ecosystems to update and where the package manifests are located.
|
|
3
|
+
# Please see the documentation for all configuration options:
|
|
4
|
+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
|
|
5
|
+
|
|
6
|
+
version: 2
|
|
7
|
+
updates:
|
|
8
|
+
- package-ecosystem: "pip" # See documentation for possible values
|
|
9
|
+
directory: "/" # Location of package manifests
|
|
10
|
+
schedule:
|
|
11
|
+
interval: "daily"
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
name: "CodeQL"
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [ "main" ]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [ "main" ]
|
|
8
|
+
schedule:
|
|
9
|
+
- cron: '34 1 * * 6'
|
|
10
|
+
|
|
11
|
+
permissions:
|
|
12
|
+
contents: read
|
|
13
|
+
|
|
14
|
+
jobs:
|
|
15
|
+
analyze:
|
|
16
|
+
name: Analyze (${{ matrix.language }})
|
|
17
|
+
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
|
|
18
|
+
timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
|
|
19
|
+
permissions:
|
|
20
|
+
# required for all workflows
|
|
21
|
+
security-events: write
|
|
22
|
+
|
|
23
|
+
strategy:
|
|
24
|
+
fail-fast: false
|
|
25
|
+
matrix:
|
|
26
|
+
include:
|
|
27
|
+
- language: python
|
|
28
|
+
build-mode: none
|
|
29
|
+
steps:
|
|
30
|
+
- name: Harden the runner (Audit all outbound calls)
|
|
31
|
+
uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
|
|
32
|
+
with:
|
|
33
|
+
egress-policy: audit
|
|
34
|
+
|
|
35
|
+
- name: Checkout repository
|
|
36
|
+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
|
37
|
+
|
|
38
|
+
# Initializes the CodeQL tools for scanning.
|
|
39
|
+
- name: Initialize CodeQL
|
|
40
|
+
uses: github/codeql-action/init@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3.28.18
|
|
41
|
+
with:
|
|
42
|
+
languages: ${{ matrix.language }}
|
|
43
|
+
build-mode: ${{ matrix.build-mode }}
|
|
44
|
+
|
|
45
|
+
- name: Perform CodeQL Analysis
|
|
46
|
+
uses: github/codeql-action/analyze@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3.28.18
|
|
47
|
+
with:
|
|
48
|
+
category: "/language:${{matrix.language}}"
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
name: 'Dependency Review'
|
|
2
|
+
on: [pull_request]
|
|
3
|
+
|
|
4
|
+
permissions:
|
|
5
|
+
contents: read
|
|
6
|
+
pull-requests: write
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
dependency-review:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
steps:
|
|
12
|
+
- name: Harden the runner (Audit all outbound calls)
|
|
13
|
+
uses: step-security/harden-runner@002fdce3c6a235733a90a27c80493a3241e56863 # v2.12.1
|
|
14
|
+
with:
|
|
15
|
+
egress-policy: audit
|
|
16
|
+
|
|
17
|
+
- name: 'Checkout Repository'
|
|
18
|
+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
|
19
|
+
- name: Dependency Review
|
|
20
|
+
uses: actions/dependency-review-action@da24556b548a50705dd671f47852072ea4c105d9 # v4.7.1
|
|
21
|
+
with:
|
|
22
|
+
comment-summary-in-pr: always
|
|
23
|
+
fail-on-severity: high
|
|
24
|
+
allow-licenses: MIT, Apache-2.0, BSD-3-Clause, ISC, BSD-2-Clause, Unlicense, CC0-1.0, 0BSD, X11, MPL-2.0, MPL-1.0, MPL-1.1, MPL-2.0
|
|
25
|
+
fail-on-scopes: development, runtime
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
name: Publish documentation to GitHub Pages
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [created]
|
|
6
|
+
workflow_dispatch:
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: read
|
|
10
|
+
pages: write
|
|
11
|
+
id-token: write
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
deploy:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- name: Harden the runner (Audit all outbound calls)
|
|
18
|
+
uses: step-security/harden-runner@002fdce3c6a235733a90a27c80493a3241e56863 # v2.12.1
|
|
19
|
+
with:
|
|
20
|
+
egress-policy: audit
|
|
21
|
+
|
|
22
|
+
- name: Checkout code
|
|
23
|
+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
|
24
|
+
|
|
25
|
+
- name: Set up Python 3.10
|
|
26
|
+
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
|
|
27
|
+
with:
|
|
28
|
+
python-version: "3.10"
|
|
29
|
+
|
|
30
|
+
- name: Install dependencies
|
|
31
|
+
run: |
|
|
32
|
+
python -m pip install --upgrade pip
|
|
33
|
+
pip install -r requirements.txt
|
|
34
|
+
pip install -r docs/requirements.txt
|
|
35
|
+
|
|
36
|
+
- name: Build documentation
|
|
37
|
+
run: cd docs && make html
|
|
38
|
+
|
|
39
|
+
- name: Upload Pages artifact
|
|
40
|
+
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
|
|
41
|
+
with:
|
|
42
|
+
path: './docs/build/html'
|
|
43
|
+
|
|
44
|
+
- name: Deploy to GitHub Pages
|
|
45
|
+
id: deployment
|
|
46
|
+
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# This workflow will install Python dependencies, run tests and lint with a single version of Python
|
|
2
|
+
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
|
|
3
|
+
|
|
4
|
+
name: Python Linter And Unittest
|
|
5
|
+
|
|
6
|
+
on:
|
|
7
|
+
push:
|
|
8
|
+
branches: [ "main" ]
|
|
9
|
+
pull_request:
|
|
10
|
+
branches: [ "main" ]
|
|
11
|
+
|
|
12
|
+
permissions:
|
|
13
|
+
contents: read
|
|
14
|
+
|
|
15
|
+
jobs:
|
|
16
|
+
build:
|
|
17
|
+
|
|
18
|
+
runs-on: ubuntu-latest
|
|
19
|
+
|
|
20
|
+
steps:
|
|
21
|
+
- name: Harden the runner (Audit all outbound calls)
|
|
22
|
+
uses: step-security/harden-runner@002fdce3c6a235733a90a27c80493a3241e56863 # v2.12.1
|
|
23
|
+
with:
|
|
24
|
+
egress-policy: audit
|
|
25
|
+
|
|
26
|
+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
|
27
|
+
- name: Set up Python 3.10
|
|
28
|
+
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
|
|
29
|
+
with:
|
|
30
|
+
python-version: "3.10"
|
|
31
|
+
- name: Install dependencies
|
|
32
|
+
# TODO: add Scaler as a test dependency once it's published to Pypi
|
|
33
|
+
run: |
|
|
34
|
+
python -m pip install --upgrade pip
|
|
35
|
+
pip install flake8 pyproject-flake8 mypy
|
|
36
|
+
pip install -r requirements.txt
|
|
37
|
+
pip install pandas dask[distributed] opengris-scaler
|
|
38
|
+
- name: Lint with flake8
|
|
39
|
+
run: |
|
|
40
|
+
pflake8 .
|
|
41
|
+
- name: Lint with MyPy
|
|
42
|
+
run: |
|
|
43
|
+
mypy .
|
|
44
|
+
- name: Run python unittest
|
|
45
|
+
run: |
|
|
46
|
+
python -m unittest discover -v tests
|
|
47
|
+
- name: Run the examples
|
|
48
|
+
run: |
|
|
49
|
+
find examples -type f -name '*.py' ! -name '__init__.py' | while read -r file; do
|
|
50
|
+
echo "Running $file"
|
|
51
|
+
PYTHONPATH=. python "$file"
|
|
52
|
+
done
|
|
53
|
+
- name: Test the documentation examples
|
|
54
|
+
run: |
|
|
55
|
+
pip install -r docs/requirements.txt
|
|
56
|
+
cd docs
|
|
57
|
+
make doctest
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
name: Publish Python package to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [created]
|
|
6
|
+
|
|
7
|
+
permissions:
|
|
8
|
+
contents: read
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
deploy:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
environment: release
|
|
14
|
+
permissions:
|
|
15
|
+
id-token: write
|
|
16
|
+
steps:
|
|
17
|
+
- name: Harden the runner (Audit all outbound calls)
|
|
18
|
+
uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
|
|
19
|
+
with:
|
|
20
|
+
egress-policy: audit
|
|
21
|
+
|
|
22
|
+
- name: Checkout code
|
|
23
|
+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
|
24
|
+
- name: Set up Python 3.10
|
|
25
|
+
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
|
|
26
|
+
with:
|
|
27
|
+
python-version: "3.10"
|
|
28
|
+
- name: Install dependencies
|
|
29
|
+
run: |
|
|
30
|
+
python -m pip install --upgrade pip
|
|
31
|
+
pip install build
|
|
32
|
+
pip install -r requirements.txt
|
|
33
|
+
|
|
34
|
+
- name: Build package
|
|
35
|
+
run: python -m build
|
|
36
|
+
|
|
37
|
+
- name: Publish to PyPI
|
|
38
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
name: Scorecard supply-chain security
|
|
2
|
+
on:
|
|
3
|
+
# For Branch-Protection check. Only the default branch is supported. See
|
|
4
|
+
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
|
|
5
|
+
branch_protection_rule:
|
|
6
|
+
# To guarantee Maintained check is occasionally updated. See
|
|
7
|
+
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
|
|
8
|
+
schedule:
|
|
9
|
+
- cron: '26 18 * * 0'
|
|
10
|
+
push:
|
|
11
|
+
branches: [ "main" ]
|
|
12
|
+
|
|
13
|
+
# Declare default permissions as read only.
|
|
14
|
+
permissions: read-all
|
|
15
|
+
|
|
16
|
+
jobs:
|
|
17
|
+
analysis:
|
|
18
|
+
name: Scorecard analysis
|
|
19
|
+
runs-on: ubuntu-latest
|
|
20
|
+
permissions:
|
|
21
|
+
# Needed to upload the results to code-scanning dashboard.
|
|
22
|
+
security-events: write
|
|
23
|
+
# Needed to publish results and get a badge (see publish_results below).
|
|
24
|
+
id-token: write
|
|
25
|
+
# Uncomment the permissions below if installing in a private repository.
|
|
26
|
+
# contents: read
|
|
27
|
+
# actions: read
|
|
28
|
+
|
|
29
|
+
steps:
|
|
30
|
+
- name: Harden Runner
|
|
31
|
+
uses: step-security/harden-runner@002fdce3c6a235733a90a27c80493a3241e56863 # v2.12.1
|
|
32
|
+
with:
|
|
33
|
+
egress-policy: audit
|
|
34
|
+
|
|
35
|
+
- name: "Checkout code"
|
|
36
|
+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
|
37
|
+
with:
|
|
38
|
+
persist-credentials: false
|
|
39
|
+
|
|
40
|
+
- name: "Run analysis"
|
|
41
|
+
uses: ossf/scorecard-action@05b42c624433fc40578a4040d5cf5e36ddca8cde # v2.4.2
|
|
42
|
+
with:
|
|
43
|
+
results_file: results.sarif
|
|
44
|
+
results_format: sarif
|
|
45
|
+
# (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
|
|
46
|
+
# - you want to enable the Branch-Protection check on a *public* repository, or
|
|
47
|
+
# - you are installing Scorecard on a *private* repository
|
|
48
|
+
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
|
|
49
|
+
# repo_token: ${{ secrets.SCORECARD_TOKEN }}
|
|
50
|
+
|
|
51
|
+
# Public repositories:
|
|
52
|
+
# - Publish results to OpenSSF REST API for easy access by consumers
|
|
53
|
+
# - Allows the repository to include the Scorecard badge.
|
|
54
|
+
# - See https://github.com/ossf/scorecard-action#publishing-results.
|
|
55
|
+
# For private repositories:
|
|
56
|
+
# - `publish_results` will always be set to `false`, regardless
|
|
57
|
+
# of the value entered here.
|
|
58
|
+
publish_results: true
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
We welcome contributions to the OpenGRIS Parfun library.
|
|
2
|
+
|
|
3
|
+
# OpenGRIS Parfun Contribution and Governance Policies
|
|
4
|
+
|
|
5
|
+
This document describes the contribution process and governance policies of the FINOS OpenGRIS Parfun project. The project is also governed by the [Linux Foundation Antitrust Policy](https://www.linuxfoundation.org/antitrust-policy/), and the FINOS [IP Policy]( https://community.finos.org/governance-docs/IP-policy.pdf), [Code of Conduct](https://community.finos.org/docs/governance/code-of-conduct), [Collaborative Principles](https://community.finos.org/docs/governance/collaborative-principles/), and [Meeting Procedures](https://community.finos.org/docs/governance/meeting-procedures/).
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Helpful Resources
|
|
9
|
+
|
|
10
|
+
* [README.md](./README.md)
|
|
11
|
+
|
|
12
|
+
* Documentation: [./docs](./docs) (see [README.md](./README.md) for building instructions)
|
|
13
|
+
|
|
14
|
+
* [Repository](https://github.com/finos/opengris-parfun)
|
|
15
|
+
|
|
16
|
+
* [Issue tracking](https://github.com/finos/opengris-parfun/issues)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Contributing Guide
|
|
20
|
+
|
|
21
|
+
When contributing to the project, please take care of following these requirements.
|
|
22
|
+
|
|
23
|
+
NOTE: All contributors must have a contributor license agreement (CLA) on file with FINOS before their pull requests can be merged. Please review the FINOS [contribution requirements](https://community.finos.org/docs/governance/Software-Projects/contribution-compliance-requirements) and submit (or have your employer submit) the required CLA before submitting a pull request.
|
|
24
|
+
|
|
25
|
+
### Style guide
|
|
26
|
+
|
|
27
|
+
**We enforce the [PEP 8](https://peps.python.org/pep-0008/) coding style, with a relaxed constraint on the maximum line
|
|
28
|
+
length (120 columns)**.
|
|
29
|
+
|
|
30
|
+
Before merging your changes into your `master` branch, our CI system will run the following checks:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
isort --profile black --line-length 120
|
|
34
|
+
black -l 120 -C
|
|
35
|
+
flake8 --max-line-length 120 --extend-ignore=E203
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
The `isort`, `black` and `flake8` packages can be installed through Python's PIP.
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### Bump version number
|
|
42
|
+
|
|
43
|
+
Before pushing your pull request, please update the version number of the library in the
|
|
44
|
+
[about.py](./parfun/about.py) file.
|
|
45
|
+
|
|
46
|
+
Update the minor version number if your changes are backward-compatible, otherwise update the major version number:
|
|
47
|
+
|
|
48
|
+
```python
|
|
49
|
+
# Original
|
|
50
|
+
__version__ = "1.29"
|
|
51
|
+
|
|
52
|
+
# Non-breaking changes
|
|
53
|
+
__version__ = "1.30"
|
|
54
|
+
|
|
55
|
+
# Breaking changes
|
|
56
|
+
__version__ = "2.0"
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Governance
|
|
60
|
+
|
|
61
|
+
### Roles
|
|
62
|
+
|
|
63
|
+
The project community consists of Contributors and Maintainers:
|
|
64
|
+
* A **Contributor** is anyone who submits a contribution to the project. (Contributions may include code, issues, comments, documentation, media, or any combination of the above.)
|
|
65
|
+
* A **Maintainer** is a Contributor who, by virtue of their contribution history, has been given write access to project repositories and may merge approved contributions.
|
|
66
|
+
* The **Lead Maintainer** is the project's interface with the FINOS team and Board. They are responsible for approving [quarterly project reports](https://community.finos.org/docs/governance/#project-governing-board-reporting) and communicating on behalf of the project. The Lead Maintainer is elected by a vote of the Maintainers.
|
|
67
|
+
|
|
68
|
+
### Contribution Rules
|
|
69
|
+
|
|
70
|
+
Anyone is welcome to submit a contribution to the project. The rules below apply to all contributions. (The key words "MUST", "SHALL", "SHOULD", "MAY", etc. in this document are to be interpreted as described in [IETF RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).)
|
|
71
|
+
|
|
72
|
+
* All contributions MUST be submitted as pull requests, including contributions by Maintainers.
|
|
73
|
+
* All pull requests SHOULD be reviewed by a Maintainer (other than the Contributor) before being merged.
|
|
74
|
+
* Pull requests for non-trivial contributions SHOULD remain open for a review period sufficient to give all Maintainers a sufficient opportunity to review and comment on them.
|
|
75
|
+
* After the review period, if no Maintainer has an objection to the pull request, any Maintainer MAY merge it.
|
|
76
|
+
* If any Maintainer objects to a pull request, the Maintainers SHOULD try to come to consensus through discussion. If not consensus can be reached, any Maintainer MAY call for a vote on the contribution.
|
|
77
|
+
|
|
78
|
+
### Maintainer Voting
|
|
79
|
+
|
|
80
|
+
The Maintainers MAY hold votes only when they are unable to reach consensus on an issue. Any Maintainer MAY call a vote on a contested issue, after which Maintainers SHALL have 36 hours to register their votes. Votes SHALL take the form of "+1" (agree), "-1" (disagree), "+0" (abstain). Issues SHALL be decided by the majority of votes cast. If there is only one Maintainer, they SHALL decide any issue otherwise requiring a Maintainer vote. If a vote is tied, the Lead Maintainer MAY cast an additional tie-breaker vote.
|
|
81
|
+
|
|
82
|
+
The Maintainers SHALL decide the following matters by consensus or, if necessary, a vote:
|
|
83
|
+
* Contested pull requests
|
|
84
|
+
* Election and removal of the Lead Maintainer
|
|
85
|
+
* Election and removal of Maintainers
|
|
86
|
+
|
|
87
|
+
All Maintainer votes MUST be carried out transparently, with all discussion and voting occurring in public, either:
|
|
88
|
+
* in comments associated with the relevant issue or pull request, if applicable;
|
|
89
|
+
* on the project mailing list or other official public communication channel; or
|
|
90
|
+
* during a regular, minuted project meeting.
|
|
91
|
+
|
|
92
|
+
### Maintainer Qualifications
|
|
93
|
+
|
|
94
|
+
Any Contributor who has made a substantial contribution to the project MAY apply (or be nominated) to become a Maintainer. The existing Maintainers SHALL decide whether to approve the nomination according to the Maintainer Voting process above.
|
|
95
|
+
|
|
96
|
+
### Changes to this Document
|
|
97
|
+
|
|
98
|
+
This document MAY be amended by a vote of the Maintainers according to the Maintainer Voting process above.
|
|
99
|
+
|
|
100
|
+
## Code of Conduct
|
|
101
|
+
|
|
102
|
+
Please see the FINOS [Community Code of Conduct](https://www.finos.org/code-of-conduct).
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2023 Citigroup, Inc.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
OpenGRIS Scaler
|
|
2
|
+
Copyright 2023 - 2025 - Citigroup, Inc.
|
|
3
|
+
Copyright 2025 - FINOS info@finos.org
|
|
4
|
+
|
|
5
|
+
This product includes software developed by Citigroup (https://www.citigroup.com/).
|
|
6
|
+
|
|
7
|
+
This product includes software developed at the Fintech Open Source Foundation (https://www.finos.org/).
|