Skip to content

Commit a26a136

Browse files
betinacostacassiofariasmachado
betinacosta
and
cassiofariasmachado
authored
feat: merge initial branch (#2)
Co-authored-by: Cássio Farias Machado <cassio.machado@sap.com>
1 parent 02f2090 commit a26a136

File tree

113 files changed

+29013
-22
lines changed

Some content is hidden

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

113 files changed

+29013
-22
lines changed

‎.commitlintrc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": ["@commitlint/config-conventional"]
3+
}

‎.env_integration_test.example‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
CLOUD_SDK_OTEL_DISABLED=true
2+
3+
CLOUD_SDK_CFG_AUDITLOG_DEFAULT_URL=https://your-auditlog-api-url-here
4+
CLOUD_SDK_CFG_AUDITLOG_DEFAULT_UAA='{"url":"https://your-auth-url","clientid":"your-client-id","clientsecret":"your-client-secret"}'
5+
6+
CLOUD_SDK_CFG_OBJECTSTORE_DEFAULT_HOST=your-objectstore-host-here
7+
CLOUD_SDK_CFG_OBJECTSTORE_DEFAULT_ACCESS_KEY_ID=your-access-key-id-here
8+
CLOUD_SDK_CFG_OBJECTSTORE_DEFAULT_SECRET_ACCESS_KEY=your-secret-access-key-here
9+
CLOUD_SDK_CFG_OBJECTSTORE_DEFAULT_BUCKET=your-bucket-name-here
10+
11+
CLOUD_SDK_CFG_DESTINATION_DEFAULT_CLIENTID=your-destination-client-id-here
12+
CLOUD_SDK_CFG_DESTINATION_DEFAULT_CLIENTSECRET=your-destination-client-secret-here
13+
CLOUD_SDK_CFG_DESTINATION_DEFAULT_URL=https://your-destination-auth-url-here
14+
CLOUD_SDK_CFG_DESTINATION_DEFAULT_URI=https://your-destination-configuration-uri-here
15+
CLOUD_SDK_CFG_DESTINATION_DEFAULT_IDENTITYZONE=your-identity-zone-here

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
name: Bug Report
2+
description: Released feature does not work as expected in the SAP Cloud SDK for Python.
3+
labels:
4+
- bug
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: "Describe the Bug"
9+
description: "A clear and concise description of what the bug is."
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: "Steps to Reproduce"
15+
description: "Steps to reproduce the behavior."
16+
placeholder: |
17+
1. Set up ...
18+
2. Execute ...
19+
3. Confirm ...
20+
4. See error
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: "Expected Behavior"
26+
description: "A clear and concise description of what you expected to happen. In case of HTTP requests, a working Postman (or similar) request is very helpful."
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: "Screenshots"
32+
description: "Add screenshots to help explain your problem."
33+
validations:
34+
required: false
35+
- type: textarea
36+
attributes:
37+
label: "Used Versions"
38+
description: "Provide versions used in the project."
39+
value: |
40+
- Python version via `python --version`: ...
41+
- SAP Cloud SDK for Python version: ...
42+
- Framework version (if applicable, e.g., Flask, FastAPI): ...
43+
44+
<details><summary>Installed packages via <code>pip list</code> or <code>uv pip list</code></summary>
45+
46+
```
47+
Package list here
48+
```
49+
</details>
50+
validations:
51+
required: true
52+
- type: textarea
53+
attributes:
54+
label: "Code Examples"
55+
description: "Add code snippets as examples to help explain your problem. Please remove sensitive information."
56+
value: |
57+
```python
58+
# Your code here
59+
```
60+
validations:
61+
required: false
62+
- type: textarea
63+
attributes:
64+
label: "Stack Trace"
65+
description: "Add your stack trace here. Please remove sensitive information."
66+
validations:
67+
required: false
68+
- type: textarea
69+
attributes:
70+
label: "Log File"
71+
description: "Add your log file or related error message. Please remove sensitive information."
72+
value: |
73+
<details><summary>Log file</summary>
74+
...
75+
</details>
76+
validations:
77+
required: false
78+
- type: dropdown
79+
attributes:
80+
label: "Affected Development Phase"
81+
description: "Choose the development phase affected by this issue."
82+
multiple: false
83+
options:
84+
- Getting Started
85+
- Development
86+
- Release
87+
- Production
88+
validations:
89+
required: true
90+
- type: dropdown
91+
attributes:
92+
label: "Impact"
93+
description: "Choose the impact severity."
94+
multiple: false
95+
options:
96+
- No Impact
97+
- Inconvenience
98+
- Impaired
99+
- Blocked
100+
validations:
101+
required: true
102+
- type: textarea
103+
attributes:
104+
label: "Timeline"
105+
description: "Please briefly state your timeline, e.g., Go-Live in 12 weeks."
106+
validations:
107+
required: false

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Feature Request
2+
description: Request a new feature to help your project using the SAP Cloud SDK for Python.
3+
labels:
4+
- feature request
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: "Describe the Problem"
9+
description: "A clear and concise description of what the missing feature is"
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: "Propose a Solution"
15+
description: "A clear and concise description of what you want to happen. In case of HTTP requests, a working Postman (or similar) request is very helpful."
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: "Describe Alternatives"
21+
description: "A clear and concise description of any alternative solutions or features you've considered."
22+
validations:
23+
required: false
24+
- type: dropdown
25+
attributes:
26+
label: "Affected Development Phase"
27+
description: "Choose the development phase affected by this issue."
28+
multiple: false
29+
options:
30+
- Getting Started
31+
- Development
32+
- Release
33+
- Production
34+
validations:
35+
required: true
36+
- type: dropdown
37+
attributes:
38+
label: "Impact"
39+
description: "Choose the impact severity."
40+
multiple: false
41+
options:
42+
- No Impact
43+
- Inconvenience
44+
- Impaired
45+
- Blocked
46+
validations:
47+
required: true
48+
- type: textarea
49+
attributes:
50+
label: "Timeline"
51+
description: "Please briefly state your timeline, e.g., Go-Live in 12 weeks."
52+
validations:
53+
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Question
2+
description: Ask a question about the SAP Cloud SDK for Python.
3+
labels:
4+
- question
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: "Ask the Question"
9+
description: Give a clear and concise description.
10+
validations:
11+
required: true

‎.github/pull_request_template.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
## Description
2+
3+
Provide a clear description of your changes here.
4+
5+
## Related Issue
6+
7+
Closes #<issue_number>
8+
9+
(Link to the GitHub issue this PR addresses)
10+
11+
## Type of Change
12+
13+
Please check the relevant option:
14+
15+
- [ ] Bug fix (non-breaking change that fixes an issue)
16+
- [ ] New feature (non-breaking change that adds functionality)
17+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
18+
- [ ] Documentation update
19+
- [ ] Code refactoring
20+
- [ ] Dependency update
21+
22+
## How to Test
23+
24+
Describe how reviewers can test your changes:
25+
26+
1. Step 1
27+
2. Step 2
28+
3. Expected result
29+
30+
## Checklist
31+
32+
Before submitting your PR, please review and check the following:
33+
34+
- [ ] I have read the [Contributing Guidelines](../docs/CONTRIBUTING.md)
35+
- [ ] I have verified that my changes solve the issue
36+
- [ ] I have added/updated automated tests to cover my changes
37+
- [ ] All tests pass locally
38+
- [ ] I have verified that my code follows the [Code Guidelines](../docs/GUIDELINES.md)
39+
- [ ] I have updated documentation (if applicable)
40+
- [ ] I have added type hints for all public APIs
41+
- [ ] My code does not contain sensitive information (credentials, tokens, etc.)
42+
- [ ] I have followed [Conventional Commits](https://www.conventionalcommits.org/) for commit messages
43+
44+
## Breaking Changes
45+
46+
If this PR introduces breaking changes, please describe:
47+
48+
- What breaks
49+
- Migration path for users
50+
- Alternative approaches considered
51+
52+
## Additional Notes
53+
54+
Add any additional context, screenshots, or information that would help reviewers.

‎.github/workflows/reuse.yaml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: REUSE Compliance Check
2+
3+
on:
4+
push:
5+
branches:
6+
- "main"
7+
pull_request:
8+
branches:
9+
- "main"
10+
11+
jobs:
12+
check-reuse-compliance:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v6
16+
17+
- name: REUSE Compliance Check
18+
uses: fsfe/reuse-action@v6.0.0

‎.gitignore‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# uv
2+
# Keep uv.lock for reproducible builds, but ignore cache
3+
.uv/
4+
.uv_cache/
5+
6+
# Python
7+
__pycache__/
8+
9+
# Environments
10+
.env*
11+
!.env*.example
12+
.venv
13+
env/
14+
venv/
15+
ENV/
16+
env.bak/
17+
venv.bak/
18+
piperBuild-env/
19+
20+
# IDEs
21+
.vscode/
22+
.idea/
23+
24+
# Logs
25+
logs/
26+
*.log
27+
28+
# Coverage reports
29+
.coverage
30+
coverage.*
31+
test-results.*
32+
33+
# SonarQube Reports
34+
.sonar*
35+
36+
# Local Mode
37+
localauditlog.jsonl

0 commit comments

Comments
 (0)