Skip to content

Commit ee4317e

Browse files
committed
Pilot HDC 1.2
1 parent e249fcf commit ee4317e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+8058
-1
lines changed

.editorconfig

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
tab_width = 4
6+
indent_style = space
7+
8+
[*.py]
9+
end_of_line = lf
10+
indent_size = 4
11+
trim_trailing_whitespace = true
12+
insert_final_newline = true
13+
14+
[*.{yml,yaml}]
15+
end_of_line = lf
16+
indent_size = 2
17+
trim_trailing_whitespace = true
18+
insert_final_newline = true

.env.schema

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
CONFIG_CENTER_ENABLED=false
2+
3+
# If config center has been enabled
4+
VAULT_URL=
5+
VAULT_CRT=
6+
VAULT_TOKEN=
7+
S3_INTERNAL_HTTPS=
8+
S3_PORT=
9+
S3_HOST=
10+
RDS_DBNAME=
11+
RDS_HOST=
12+
RDS_PORT=
13+
AUDIT_TRAIL_SERVICE=
14+
DATAOPS_SERVICE=
15+
LINEAGE_SERVICE=
16+
GREEN_ZONE_LABEL=
17+
CORE_ZONE_LABEL=
18+
METADATA_SERVICE=
19+
PROJECT_SERVICE=
20+
REDIS_HOST=
21+
REDIS_PORT=
22+
REDIS_PASSWORD=
23+
KAFKA_URL=
24+
S3_ACCESS_KEY=
25+
S3_SECRET_KEY=
26+
APPROVAL_SERVICE=
27+
NOTIFICATION_SERVICE=

.gitignore

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*.pyc
2+
*~
3+
*.swp
4+
*.log
5+
*.log.*
6+
.braincodePassFile
7+
test.sh
8+
.DS_Store
9+
# pycharm
10+
.idea
11+
.env
12+
venv

.pre-commit-config.yaml

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
default_language_version:
2+
python: python3.10
3+
4+
repos:
5+
6+
- repo: https://github.com/pre-commit/pre-commit-hooks
7+
rev: v4.6.0
8+
hooks:
9+
- id: check-added-large-files
10+
- id: check-docstring-first
11+
- id: check-merge-conflict
12+
- id: check-toml
13+
- id: check-yaml
14+
- id: double-quote-string-fixer
15+
- id: end-of-file-fixer
16+
- id: trailing-whitespace
17+
18+
- repo: https://github.com/asottile/pyupgrade
19+
rev: v3.17.0
20+
hooks:
21+
- id: pyupgrade
22+
args: [
23+
'--py310-plus',
24+
]
25+
26+
- repo: https://github.com/psf/black
27+
rev: 24.8.0
28+
hooks:
29+
- id: black
30+
args: [
31+
'--line-length=120',
32+
'--skip-string-normalization',
33+
]
34+
35+
- repo: https://github.com/PyCQA/isort
36+
rev: 5.13.2
37+
hooks:
38+
- id: isort
39+
args: [
40+
'--line-length=120',
41+
'--profile=black',
42+
'--filter-files',
43+
'--force-single-line-imports',
44+
'--reverse-relative',
45+
]
46+
47+
- repo: https://github.com/PyCQA/flake8
48+
rev: 5.0.4
49+
hooks:
50+
- id: flake8
51+
additional_dependencies: [
52+
'pycodestyle==2.9.1', # E,W
53+
'pyflakes==2.5.0', # F
54+
'mccabe==0.7.0', # C
55+
'flake8-bugbear==22.9.11', # B
56+
'flake8-builtins==1.5.3', # A
57+
'flake8-comprehensions==3.10.0', # C4
58+
'flake8-debugger==4.1.2', # T1
59+
'flake8-logging-format==0.7.5', # G
60+
'flake8-use-fstring==1.4.0', # FS
61+
'flake8-print==5.0.0', # T2
62+
]
63+
args: [
64+
'--select=E,W,F,C,B,A,C4,T1,G,FS,T2',
65+
'--ignore=E203,W503,B008,B305,A003,G004',
66+
'--max-complexity=10',
67+
'--max-line-length=120',
68+
]
69+
70+
# - repo: https://github.com/PyCQA/docformatter
71+
# rev: v1.7.5
72+
# hooks:
73+
# - id: docformatter
74+
# args: [
75+
# '--wrap-summaries=120',
76+
# '--wrap-descriptions=120',
77+
# '--in-place',
78+
# ]
79+
80+
- repo: https://github.com/Lucas-C/pre-commit-hooks
81+
rev: v1.5.5
82+
hooks:
83+
- id: insert-license
84+
files: \.py$
85+
args: [
86+
'--license-filepath=COPYRIGHT',
87+
'--comment-style=#',
88+
]

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contribution Guide
2+
3+
## Bug Reports
4+
5+
For bug reports, [submit an issue](https://github.com/PilotDataPlatform/pipelines/issues).
6+
7+
## Pull Requests
8+
9+
1. Fork the [main repository](https://github.com/PilotDataPlatform/pipelines.git).
10+
2. Create a feature branch to hold your changes.
11+
3. Work on the changes in your feature branch.
12+
4. Add [Unit Tests](#unit-tests).
13+
5. Follow the Getting Started instruction to set up the service.
14+
6. Create the Alembic [migration](#migrations) environment only when it's needed.
15+
7. Test the code and create a pull request.
16+
17+
### Unit Tests
18+
19+
When adding a new feature or fixing a bug, unit tests are necessary to write. Currently we use Pytest as our testing framework and all test cases are written under the `tests` directory.
20+
21+
Run test cases with Poetry and Pytest:
22+
```
23+
poetry run pytest
24+
```

COPYRIGHT

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Copyright (C) 2022-Present Indoc Systems
2+
3+
Licensed under the GNU AFFERO GENERAL PUBLIC LICENSE,
4+
Version 3.0 (the "License") available at https://www.gnu.org/licenses/agpl-3.0.en.html.
5+
You may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)