Skip to content

Commit

Permalink
Pilot HDC 1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
mloshakov committed Oct 9, 2024
1 parent e249fcf commit 4e87f7a
Show file tree
Hide file tree
Showing 79 changed files with 8,061 additions and 1 deletion.
18 changes: 18 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
root = true

[*]
charset = utf-8
tab_width = 4
indent_style = space

[*.py]
end_of_line = lf
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true

[*.{yml,yaml}]
end_of_line = lf
indent_size = 2
trim_trailing_whitespace = true
insert_final_newline = true
27 changes: 27 additions & 0 deletions .env.schema
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
CONFIG_CENTER_ENABLED=false

# If config center has been enabled
VAULT_URL=
VAULT_CRT=
VAULT_TOKEN=
S3_INTERNAL_HTTPS=
S3_PORT=
S3_HOST=
RDS_DBNAME=
RDS_HOST=
RDS_PORT=
AUDIT_TRAIL_SERVICE=
DATAOPS_SERVICE=
LINEAGE_SERVICE=
GREEN_ZONE_LABEL=
CORE_ZONE_LABEL=
METADATA_SERVICE=
PROJECT_SERVICE=
REDIS_HOST=
REDIS_PORT=
REDIS_PASSWORD=
KAFKA_URL=
S3_ACCESS_KEY=
S3_SECRET_KEY=
APPROVAL_SERVICE=
NOTIFICATION_SERVICE=
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
*.pyc
*~
*.swp
*.log
*.log.*
.braincodePassFile
test.sh
.DS_Store
# pycharm
.idea
.env
venv
88 changes: 88 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
default_language_version:
python: python3.10

repos:

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: check-added-large-files
- id: check-docstring-first
- id: check-merge-conflict
- id: check-toml
- id: check-yaml
- id: double-quote-string-fixer
- id: end-of-file-fixer
- id: trailing-whitespace

- repo: https://github.com/asottile/pyupgrade
rev: v3.17.0
hooks:
- id: pyupgrade
args: [
'--py310-plus',
]

- repo: https://github.com/psf/black
rev: 24.8.0
hooks:
- id: black
args: [
'--line-length=120',
'--skip-string-normalization',
]

- repo: https://github.com/PyCQA/isort
rev: 5.13.2
hooks:
- id: isort
args: [
'--line-length=120',
'--profile=black',
'--filter-files',
'--force-single-line-imports',
'--reverse-relative',
]

- repo: https://github.com/PyCQA/flake8
rev: 5.0.4
hooks:
- id: flake8
additional_dependencies: [
'pycodestyle==2.9.1', # E,W
'pyflakes==2.5.0', # F
'mccabe==0.7.0', # C
'flake8-bugbear==22.9.11', # B
'flake8-builtins==1.5.3', # A
'flake8-comprehensions==3.10.0', # C4
'flake8-debugger==4.1.2', # T1
'flake8-logging-format==0.7.5', # G
'flake8-use-fstring==1.4.0', # FS
'flake8-print==5.0.0', # T2
]
args: [
'--select=E,W,F,C,B,A,C4,T1,G,FS,T2',
'--ignore=E203,W503,B008,B305,A003,G004',
'--max-complexity=10',
'--max-line-length=120',
]

# - repo: https://github.com/PyCQA/docformatter
# rev: v1.7.5
# hooks:
# - id: docformatter
# args: [
# '--wrap-summaries=120',
# '--wrap-descriptions=120',
# '--in-place',
# ]

- repo: https://github.com/Lucas-C/pre-commit-hooks
rev: v1.5.5
hooks:
- id: insert-license
files: \.py$
args: [
'--license-filepath=COPYRIGHT',
'--comment-style=#',
]
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Contribution Guide

## Bug Reports

For bug reports, [submit an issue](https://github.com/PilotDataPlatform/pipelines/issues).

## Pull Requests

1. Fork the [main repository](https://github.com/PilotDataPlatform/pipelines.git).
2. Create a feature branch to hold your changes.
3. Work on the changes in your feature branch.
4. Add [Unit Tests](#unit-tests).
5. Follow the Getting Started instruction to set up the service.
6. Create the Alembic [migration](#migrations) environment only when it's needed.
7. Test the code and create a pull request.

### Unit Tests

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.

Run test cases with Poetry and Pytest:
```
poetry run pytest
```
5 changes: 5 additions & 0 deletions COPYRIGHT
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Copyright (C) 2022-Present Indoc Systems

Licensed under the GNU AFFERO GENERAL PUBLIC LICENSE,
Version 3.0 (the "License") available at https://www.gnu.org/licenses/agpl-3.0.en.html.
You may not use this file except in compliance with the License.
Loading

0 comments on commit 4e87f7a

Please sign in to comment.