Skip to content

Commit 566ec15

Browse files
NeuralAudioAINeuralAudioAI
committed
CI
1 parent 1508930 commit 566ec15

File tree

5 files changed

+175
-0
lines changed

5 files changed

+175
-0
lines changed

‎.github/ISSUE_TEMPLATE/1-bug_report.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Bug report
2+
description: Create a bug report for the NeuralAudio Python SDK
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for reporting a bug with the **NeuralAudio Python SDK**. Please fill out the sections below to help us understand and resolve the issue.
9+
10+
**Note:** The NeuralAudio Python SDK is **auto-generated from [Fern](https://www.buildwithfern.com/)** and is a wrapper around our OpenAPI specification. Direct modifications to the SDK code may be overwritten in future releases.
11+
12+
- type: textarea
13+
attributes:
14+
label: Description
15+
description: |
16+
**Describe the bug in detail and provide clear steps to reproduce it.**
17+
18+
Include information such as:
19+
- What you were trying to achieve.
20+
- What happened instead.
21+
- Any relevant parameters or configurations.
22+
placeholder: |
23+
**Steps to reproduce:**
24+
1. ...
25+
2. ...
26+
27+
**Expected behavior:**
28+
29+
**Actual behavior:**
30+
validations:
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: Code example
35+
description: Provide an example code snippet that has the problem (Make sure to **NOT** upload or expose your API key).
36+
placeholder: |
37+
```python
38+
from neuralaudio import generate, play
39+
40+
# Your code here
41+
```
42+
- type: textarea
43+
attributes:
44+
label: Additional context
45+
description: |
46+
Add any other context or screenshots about the problem here.
47+
placeholder: |
48+
- Related issues:
49+
- Possible workaround:
50+
- Logs
51+
- ...

‎.github/ISSUE_TEMPLATE/2-feature_request.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Feature Request
2+
description: Propose a new feature for the NeuralAudio Python SDK
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to propose a new feature for the **NeuralAudio Python SDK**. Please provide detailed information below to help us understand your proposal.
9+
10+
**Note:** The NeuralAudio Python SDK is **auto-generated from [Fern](https://fern.dev)** and is a wrapper around our OpenAPI specification. Additions made directly to the SDK code may be overwritten in future releases. We recommend opening an issue to discuss your feature request so we can explore how it fits into our API.
11+
12+
- type: textarea
13+
attributes:
14+
label: Feature Description
15+
description: A detailed description of the feature you are proposing for the SDK. Include information such as the problem it solves, how it would work, and any relevant APIs or modules it would involve.
16+
placeholder: |
17+
**Feature description:**
18+
19+
- What is the feature?
20+
- What problem does it solve?
21+
- How do you envision it working?
22+
validations:
23+
required: false
24+
- type: textarea
25+
attributes:
26+
label: Use Case
27+
description: Provide one or more use cases where this feature would be beneficial.
28+
placeholder: |
29+
**Use case:**
30+
31+
- Describe a scenario where this feature would be useful.
32+
- type: textarea
33+
attributes:
34+
label: Alternatives Considered
35+
description: Describe any alternative solutions or features you've considered.
36+
placeholder: |
37+
**Alternatives considered:**
38+
39+
- Other ways to solve the problem?
40+
- Why do these alternatives fall short?
41+
validations:
42+
required: false
43+
- type: textarea
44+
attributes:
45+
label: Additional Context
46+
description: Any extra information, references, or screenshots that might help us understand your feature request.
47+
placeholder: |
48+
- Related issues or discussions:
49+
- Relevant links:
50+
- Screenshots or mockups:
51+
validations:
52+
required: false

‎.github/SECURITY.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Reporting Security Issues
2+
3+
If you believe you have found a security vulnerability, we encourage you to let us know right away.
4+
5+
We will investigate all legitimate reports and do our best to quickly fix the problem.
6+
7+
## Bug Bounty Program
8+
9+
Please note that NeuralAudio does not offer cash-based rewards for vulnerability reports at this time.

‎.github/workflows/ci.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: ci
2+
3+
on: [push]
4+
jobs:
5+
compile:
6+
runs-on: ubuntu-24.04
7+
steps:
8+
- name: Checkout repo
9+
uses: actions/checkout@v3
10+
- name: Set up python
11+
uses: actions/setup-python@v4
12+
with:
13+
python-version: 3.8
14+
- name: Bootstrap poetry
15+
run: |
16+
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
17+
- name: Install dependencies
18+
run: poetry install
19+
- name: Compile
20+
run: poetry run mypy .

‎.github/workflows/tests.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Test SDK
2+
3+
on: [push]
4+
jobs:
5+
compile:
6+
runs-on: ubuntu-24.04
7+
steps:
8+
- name: Checkout repo
9+
uses: actions/checkout@v3
10+
- name: Set up python
11+
uses: actions/setup-python@v4
12+
with:
13+
python-version: 3.8
14+
- name: Bootstrap poetry
15+
run: |
16+
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
17+
- name: Install dependencies
18+
run: poetry install
19+
- name: Compile
20+
run: poetry run mypy .
21+
test:
22+
runs-on: ubuntu-24.04
23+
steps:
24+
- name: Checkout repo
25+
uses: actions/checkout@v3
26+
- name: Set up python
27+
uses: actions/setup-python@v4
28+
with:
29+
python-version: 3.8
30+
- name: Bootstrap poetry
31+
run: |
32+
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
33+
- name: Install dependencies
34+
run: poetry install
35+
36+
- name: Install Fern
37+
run: npm install -g fern-api
38+
39+
- name: Test
40+
env:
41+
NEURALAUDIO_API_KEY: ${{ secrets.NEURALAUDIO_API_KEY }}
42+
run: |
43+
poetry run pytest .

0 commit comments

Comments
 (0)