Skip to content

Commit bbc2f10

Browse files
VoxHashVoxHash
committed
chore: update documentation, remove GITHUB_TOPICS.md, update .gitignore, bump version to 1.0.1
- Remove GITHUB_TOPICS.md (topics managed via GitHub UI) - Update .gitignore with comprehensive patterns - Update CHANGELOG.md for v1.0.1 release - Update setup.py version to 1.0.1 - Improve repository documentation structure
1 parent 8e8f8ba commit bbc2f10

File tree

109 files changed

+17898
-13189
lines changed

Some content is hidden

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

109 files changed

+17898
-13189
lines changed

‎.cursorindexingignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
# Don't index SpecStory auto-save files, but allow explicit context inclusion via @ references
3+
.specstory/**

‎.editorconfig‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
root = true
2-
3-
[*]
4-
charset = utf-8
5-
end_of_line = lf
6-
insert_final_newline = true
7-
trim_trailing_whitespace = true
8-
indent_style = space
9-
indent_size = 2
10-
11-
[*.md]
12-
trim_trailing_whitespace = false
13-
14-
[*.{yml,yaml}]
15-
indent_size = 2
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
indent_style = space
9+
indent_size = 2
10+
11+
[*.md]
12+
trim_trailing_whitespace = false
13+
14+
[*.{yml,yaml}]
15+
indent_size = 2

‎.github/FUNDING.yml‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# These are supported funding model platforms
2-
3-
github: [voxhash] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4-
patreon: voxhash # Replace with a single Patreon username
5-
open_collective: voxhash # Replace with a single Open Collective username
6-
ko_fi: voxhash # Replace with a single Ko-fi username
7-
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8-
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9-
liberapay: voxhash # Replace with a single Liberapay username
10-
issuehunt: voxhash # Replace with a single IssueHunt username
11-
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
12-
polar: # Replace with a single Polar username
13-
buy_me_a_coffee: voxhash # Replace with a single Buy Me a Coffee username
14-
thanks_dev: voxhash # Replace with a single thanks.dev username
15-
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
1+
# These are supported funding model platforms
2+
3+
github: [voxhash] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: voxhash # Replace with a single Patreon username
5+
open_collective: voxhash # Replace with a single Open Collective username
6+
ko_fi: voxhash # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: voxhash # Replace with a single Liberapay username
10+
issuehunt: voxhash # Replace with a single IssueHunt username
11+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
12+
polar: # Replace with a single Polar username
13+
buy_me_a_coffee: voxhash # Replace with a single Buy Me a Coffee username
14+
thanks_dev: voxhash # Replace with a single thanks.dev username
15+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1.
13+
2.
14+
3.
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Screenshots / logs**
20+
If applicable, add screenshots or error logs to help explain your problem.
21+
22+
**Environment**
23+
- OS: [e.g., Windows 10, macOS 13, Ubuntu 22.04]
24+
- Python Version: [e.g., 3.10.5]
25+
- DB Storage Manager Version: [e.g., 1.0.0]
26+
- Database Type: [e.g., PostgreSQL, MySQL, SQLite]
27+
28+
**Additional context**
29+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/docs_improvement.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Docs improvement
3+
about: Help make our docs better
4+
labels: documentation
5+
---
6+
7+
**Page/section** (link or path)
8+
Which page or section needs improvement?
9+
10+
**What's unclear or missing?**
11+
Describe what's confusing or what information is missing.
12+
13+
**Proposed change**
14+
Describe how you think the documentation should be improved.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
---
6+
7+
**Problem**
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
10+
**Proposed solution**
11+
A clear and concise description of what you want to happen.
12+
13+
**Alternatives considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context, screenshots, or examples about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Summary
2+
Brief description of changes
3+
4+
## Related issues
5+
Closes #(issue number)
6+
7+
## Changes
8+
-
9+
-
10+
-
11+
12+
## Screenshots (if UI)
13+
If applicable, add screenshots to help explain your changes.
14+
15+
## Checklist
16+
- [ ] Tests added/updated
17+
- [ ] Docs updated
18+
- [ ] Lint passes locally (`flake8 .`)
19+
- [ ] Type checking passes (`mypy .`)
20+
- [ ] Code formatted (`black .`)
21+
- [ ] CHANGELOG.md updated (if applicable)

‎.github/workflows/ci.yml‎

Lines changed: 122 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,122 @@
1-
name: CI
2-
3-
on:
4-
push:
5-
branches: [ main, develop ]
6-
pull_request:
7-
branches: [ main, develop ]
8-
9-
jobs:
10-
lint:
11-
name: Lint
12-
runs-on: ubuntu-latest
13-
strategy:
14-
matrix:
15-
python-version: ["3.10", "3.11", "3.12"]
16-
17-
steps:
18-
- name: Checkout code
19-
uses: actions/checkout@v4
20-
21-
- name: Set up Python ${{ matrix.python-version }}
22-
uses: actions/setup-python@v5
23-
with:
24-
python-version: ${{ matrix.python-version }}
25-
26-
- name: Install dependencies
27-
run: |
28-
python -m pip install --upgrade pip
29-
pip install black flake8 mypy
30-
31-
- name: Check code formatting with black
32-
run: black --check .
33-
34-
- name: Lint with flake8
35-
run: flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
36-
continue-on-error: true
37-
38-
- name: Type check with mypy
39-
run: mypy . --ignore-missing-imports
40-
continue-on-error: true
41-
42-
test:
43-
name: Test
44-
runs-on: ${{ matrix.os }}
45-
strategy:
46-
fail-fast: false
47-
matrix:
48-
os: [ubuntu-latest, windows-latest, macos-latest]
49-
python-version: ["3.10", "3.11", "3.12"]
50-
51-
steps:
52-
- name: Checkout code
53-
uses: actions/checkout@v4
54-
55-
- name: Set up Python ${{ matrix.python-version }}
56-
uses: actions/setup-python@v5
57-
with:
58-
python-version: ${{ matrix.python-version }}
59-
60-
- name: Install system dependencies (Ubuntu)
61-
if: matrix.os == 'ubuntu-latest'
62-
run: |
63-
sudo apt-get update
64-
sudo apt-get install -y python3-pyqt6 python3-pyqt6.qtcharts
65-
66-
# PyQt6 is installed via pip from requirements.txt, no system package needed
67-
68-
- name: Install dependencies
69-
run: |
70-
python -m pip install --upgrade pip
71-
pip install -r requirements.txt
72-
73-
- name: Install package in development mode
74-
run: pip install -e .
75-
76-
- name: Run tests with pytest
77-
run: pytest -v || echo "No tests found, skipping"
78-
continue-on-error: true
79-
80-
- name: Verify application can be imported
81-
run: python -c "import db_storage_manager; print('Import successful')"
82-
83-
build:
84-
name: Build
85-
runs-on: ${{ matrix.os }}
86-
needs: [lint, test]
87-
strategy:
88-
matrix:
89-
os: [ubuntu-latest, windows-latest, macos-latest]
90-
python-version: ["3.12"]
91-
92-
steps:
93-
- name: Checkout code
94-
uses: actions/checkout@v4
95-
96-
- name: Set up Python ${{ matrix.python-version }}
97-
uses: actions/setup-python@v5
98-
with:
99-
python-version: ${{ matrix.python-version }}
100-
101-
- name: Install system dependencies (Ubuntu)
102-
if: matrix.os == 'ubuntu-latest'
103-
run: |
104-
sudo apt-get update
105-
sudo apt-get install -y python3-pyqt6 python3-pyqt6.qtcharts
106-
107-
# PyQt6 is installed via pip from requirements.txt, no system package needed
108-
109-
- name: Install dependencies
110-
run: |
111-
python -m pip install --upgrade pip
112-
pip install -r requirements.txt
113-
pip install build
114-
115-
- name: Build package
116-
run: python -m build
117-
118-
- name: Upload build artifacts
119-
uses: actions/upload-artifact@v4
120-
with:
121-
name: dist-${{ matrix.os }}
122-
path: dist/
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
branches: [ main, develop ]
8+
9+
jobs:
10+
lint:
11+
name: Lint
12+
runs-on: ubuntu-latest
13+
strategy:
14+
matrix:
15+
python-version: ["3.10", "3.11", "3.12"]
16+
17+
steps:
18+
- name: Checkout code
19+
uses: actions/checkout@v4
20+
21+
- name: Set up Python ${{ matrix.python-version }}
22+
uses: actions/setup-python@v5
23+
with:
24+
python-version: ${{ matrix.python-version }}
25+
26+
- name: Install dependencies
27+
run: |
28+
python -m pip install --upgrade pip
29+
pip install black flake8 mypy
30+
31+
- name: Check code formatting with black
32+
run: black --check .
33+
34+
- name: Lint with flake8
35+
run: flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
36+
continue-on-error: true
37+
38+
- name: Type check with mypy
39+
run: mypy . --ignore-missing-imports
40+
continue-on-error: true
41+
42+
test:
43+
name: Test
44+
runs-on: ${{ matrix.os }}
45+
strategy:
46+
fail-fast: false
47+
matrix:
48+
os: [ubuntu-latest, windows-latest, macos-latest]
49+
python-version: ["3.10", "3.11", "3.12"]
50+
51+
steps:
52+
- name: Checkout code
53+
uses: actions/checkout@v4
54+
55+
- name: Set up Python ${{ matrix.python-version }}
56+
uses: actions/setup-python@v5
57+
with:
58+
python-version: ${{ matrix.python-version }}
59+
60+
- name: Install system dependencies (Ubuntu)
61+
if: matrix.os == 'ubuntu-latest'
62+
run: |
63+
sudo apt-get update
64+
sudo apt-get install -y python3-pyqt6 python3-pyqt6.qtcharts
65+
66+
# PyQt6 is installed via pip from requirements.txt, no system package needed
67+
68+
- name: Install dependencies
69+
run: |
70+
python -m pip install --upgrade pip
71+
pip install -r requirements.txt
72+
73+
- name: Install package in development mode
74+
run: pip install -e .
75+
76+
- name: Run tests with pytest
77+
run: pytest -v || echo "No tests found, skipping"
78+
continue-on-error: true
79+
80+
- name: Verify application can be imported
81+
run: python -c "import db_storage_manager; print('Import successful')"
82+
83+
build:
84+
name: Build
85+
runs-on: ${{ matrix.os }}
86+
needs: [lint, test]
87+
strategy:
88+
matrix:
89+
os: [ubuntu-latest, windows-latest, macos-latest]
90+
python-version: ["3.12"]
91+
92+
steps:
93+
- name: Checkout code
94+
uses: actions/checkout@v4
95+
96+
- name: Set up Python ${{ matrix.python-version }}
97+
uses: actions/setup-python@v5
98+
with:
99+
python-version: ${{ matrix.python-version }}
100+
101+
- name: Install system dependencies (Ubuntu)
102+
if: matrix.os == 'ubuntu-latest'
103+
run: |
104+
sudo apt-get update
105+
sudo apt-get install -y python3-pyqt6 python3-pyqt6.qtcharts
106+
107+
# PyQt6 is installed via pip from requirements.txt, no system package needed
108+
109+
- name: Install dependencies
110+
run: |
111+
python -m pip install --upgrade pip
112+
pip install -r requirements.txt
113+
pip install build
114+
115+
- name: Build package
116+
run: python -m build
117+
118+
- name: Upload build artifacts
119+
uses: actions/upload-artifact@v4
120+
with:
121+
name: dist-${{ matrix.os }}
122+
path: dist/

0 commit comments

Comments
 (0)