opero 1.0.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- opero-1.0.1/.cursor/rules/filetree.mdc +50 -0
- opero-1.0.1/.github/workflows/push.yml +112 -0
- opero-1.0.1/.github/workflows/release.yml +59 -0
- opero-1.0.1/.gitignore +315 -0
- opero-1.0.1/.pre-commit-config.yaml +20 -0
- opero-1.0.1/.specstory/history/.what-is-this.md +65 -0
- opero-1.0.1/.specstory/history/2025-03-04_03-16-comprehensive-plan-for-opero-package-implementation.md +16463 -0
- opero-1.0.1/.specstory/history/2025-03-04_05-40-cleanup-analysis-and-todo-update.md +130 -0
- opero-1.0.1/CHANGELOG.md +68 -0
- opero-1.0.1/CLEANUP.txt +443 -0
- opero-1.0.1/LICENSE +21 -0
- opero-1.0.1/PKG-INFO +446 -0
- opero-1.0.1/README.md +379 -0
- opero-1.0.1/REPO_CONTENT.txt +1961 -0
- opero-1.0.1/TODO.md +86 -0
- opero-1.0.1/cleanup.py +418 -0
- opero-1.0.1/dist/.gitkeep +0 -0
- opero-1.0.1/package.toml +11 -0
- opero-1.0.1/pyproject.toml +282 -0
- opero-1.0.1/src/opero/__init__.py +36 -0
- opero-1.0.1/src/opero/__version__.py +21 -0
- opero-1.0.1/src/opero/_version.py +5 -0
- opero-1.0.1/src/opero/concurrency.py +351 -0
- opero-1.0.1/src/opero/core.py +270 -0
- opero-1.0.1/src/opero/decorators.py +103 -0
- opero-1.0.1/src/opero/exceptions.py +22 -0
- opero-1.0.1/src/opero/opero.py +72 -0
- opero-1.0.1/src/opero/rate_limit.py +151 -0
- opero-1.0.1/src/opero/retry.py +252 -0
- opero-1.0.1/src/opero/utils.py +68 -0
- opero-1.0.1/tests/test_core.py +136 -0
- opero-1.0.1/tests/test_decorators.py +141 -0
- opero-1.0.1/tests/test_package.py +8 -0
- opero-1.0.1/uv.lock +775 -0
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: File tree of the project
|
|
3
|
+
globs:
|
|
4
|
+
---
|
|
5
|
+
[ 864] .
|
|
6
|
+
├── [ 64] .benchmarks
|
|
7
|
+
├── [ 96] .cursor
|
|
8
|
+
│ └── [ 96] rules
|
|
9
|
+
│ └── [1.6K] filetree.mdc
|
|
10
|
+
├── [ 96] .github
|
|
11
|
+
│ └── [ 128] workflows
|
|
12
|
+
│ ├── [2.7K] push.yml
|
|
13
|
+
│ └── [1.4K] release.yml
|
|
14
|
+
├── [3.5K] .gitignore
|
|
15
|
+
├── [ 532] .pre-commit-config.yaml
|
|
16
|
+
├── [ 96] .specstory
|
|
17
|
+
│ └── [ 128] history
|
|
18
|
+
│ ├── [2.6K] .what-is-this.md
|
|
19
|
+
│ └── [574K] 2025-03-04_03-16-comprehensive-plan-for-opero-package-implementation.md
|
|
20
|
+
├── [2.4K] CHANGELOG.md
|
|
21
|
+
├── [ 160] CLEANUP.txt
|
|
22
|
+
├── [1.0K] LICENSE
|
|
23
|
+
├── [9.5K] README.md
|
|
24
|
+
├── [2.6K] TODO.md
|
|
25
|
+
├── [ 13K] cleanup.py
|
|
26
|
+
├── [ 96] dist
|
|
27
|
+
│ └── [ 0] .gitkeep
|
|
28
|
+
├── [ 426] package.toml
|
|
29
|
+
├── [6.1K] pyproject.toml
|
|
30
|
+
├── [ 160] src
|
|
31
|
+
│ ├── [ 64] .benchmarks
|
|
32
|
+
│ └── [ 448] opero
|
|
33
|
+
│ ├── [1.1K] __init__.py
|
|
34
|
+
│ ├── [ 130] _version.py
|
|
35
|
+
│ ├── [9.9K] concurrency.py
|
|
36
|
+
│ ├── [9.5K] core.py
|
|
37
|
+
│ ├── [3.1K] decorators.py
|
|
38
|
+
│ ├── [ 563] exceptions.py
|
|
39
|
+
│ ├── [1.6K] opero.py
|
|
40
|
+
│ ├── [4.0K] rate_limit.py
|
|
41
|
+
│ ├── [7.8K] retry.py
|
|
42
|
+
│ └── [1.9K] utils.py
|
|
43
|
+
├── [ 192] tests
|
|
44
|
+
│ ├── [4.2K] test_core.py
|
|
45
|
+
│ ├── [4.1K] test_decorators.py
|
|
46
|
+
│ └── [ 139] test_package.py
|
|
47
|
+
├── [ 54K] twat_search.txt
|
|
48
|
+
└── [109K] uv.lock
|
|
49
|
+
|
|
50
|
+
13 directories, 31 files
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
name: Build & Test
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
tags-ignore: ["v*"]
|
|
7
|
+
pull_request:
|
|
8
|
+
branches: [main]
|
|
9
|
+
workflow_dispatch:
|
|
10
|
+
|
|
11
|
+
permissions:
|
|
12
|
+
contents: write
|
|
13
|
+
id-token: write
|
|
14
|
+
|
|
15
|
+
concurrency:
|
|
16
|
+
group: ${{ github.workflow }}-${{ github.ref }}
|
|
17
|
+
cancel-in-progress: true
|
|
18
|
+
|
|
19
|
+
jobs:
|
|
20
|
+
quality:
|
|
21
|
+
name: Code Quality
|
|
22
|
+
runs-on: ubuntu-latest
|
|
23
|
+
steps:
|
|
24
|
+
- name: Checkout code
|
|
25
|
+
uses: actions/checkout@v4
|
|
26
|
+
with:
|
|
27
|
+
fetch-depth: 0
|
|
28
|
+
|
|
29
|
+
- name: Run Ruff lint
|
|
30
|
+
uses: astral-sh/ruff-action@v3
|
|
31
|
+
with:
|
|
32
|
+
version: "latest"
|
|
33
|
+
args: "check --output-format=github"
|
|
34
|
+
|
|
35
|
+
- name: Run Ruff Format
|
|
36
|
+
uses: astral-sh/ruff-action@v3
|
|
37
|
+
with:
|
|
38
|
+
version: "latest"
|
|
39
|
+
args: "format --check --respect-gitignore"
|
|
40
|
+
|
|
41
|
+
test:
|
|
42
|
+
name: Run Tests
|
|
43
|
+
needs: quality
|
|
44
|
+
strategy:
|
|
45
|
+
matrix:
|
|
46
|
+
python-version: ["3.10", "3.11", "3.12"]
|
|
47
|
+
os: [ubuntu-latest]
|
|
48
|
+
fail-fast: true
|
|
49
|
+
runs-on: ${{ matrix.os }}
|
|
50
|
+
steps:
|
|
51
|
+
- name: Checkout code
|
|
52
|
+
uses: actions/checkout@v4
|
|
53
|
+
|
|
54
|
+
- name: Set up Python
|
|
55
|
+
uses: actions/setup-python@v5
|
|
56
|
+
with:
|
|
57
|
+
python-version: ${{ matrix.python-version }}
|
|
58
|
+
|
|
59
|
+
- name: Install UV
|
|
60
|
+
uses: astral-sh/setup-uv@v5
|
|
61
|
+
with:
|
|
62
|
+
version: "latest"
|
|
63
|
+
python-version: ${{ matrix.python-version }}
|
|
64
|
+
enable-cache: true
|
|
65
|
+
cache-suffix: ${{ matrix.os }}-${{ matrix.python-version }}
|
|
66
|
+
|
|
67
|
+
- name: Install test dependencies
|
|
68
|
+
run: |
|
|
69
|
+
uv pip install --system --upgrade pip
|
|
70
|
+
uv pip install --system ".[test]"
|
|
71
|
+
|
|
72
|
+
- name: Run tests with Pytest
|
|
73
|
+
run: uv run pytest -n auto --maxfail=1 --disable-warnings --cov-report=xml --cov-config=pyproject.toml --cov=src/opero --cov=tests tests/
|
|
74
|
+
|
|
75
|
+
- name: Upload coverage report
|
|
76
|
+
uses: actions/upload-artifact@v4
|
|
77
|
+
with:
|
|
78
|
+
name: coverage-${{ matrix.python-version }}-${{ matrix.os }}
|
|
79
|
+
path: coverage.xml
|
|
80
|
+
|
|
81
|
+
build:
|
|
82
|
+
name: Build Distribution
|
|
83
|
+
needs: test
|
|
84
|
+
runs-on: ubuntu-latest
|
|
85
|
+
steps:
|
|
86
|
+
- name: Checkout code
|
|
87
|
+
uses: actions/checkout@v4
|
|
88
|
+
|
|
89
|
+
- name: Set up Python
|
|
90
|
+
uses: actions/setup-python@v5
|
|
91
|
+
with:
|
|
92
|
+
python-version: "3.12"
|
|
93
|
+
|
|
94
|
+
- name: Install UV
|
|
95
|
+
uses: astral-sh/setup-uv@v5
|
|
96
|
+
with:
|
|
97
|
+
version: "latest"
|
|
98
|
+
python-version: "3.12"
|
|
99
|
+
enable-cache: true
|
|
100
|
+
|
|
101
|
+
- name: Install build tools
|
|
102
|
+
run: uv pip install build hatchling hatch-vcs
|
|
103
|
+
|
|
104
|
+
- name: Build distributions
|
|
105
|
+
run: uv run python -m build --outdir dist
|
|
106
|
+
|
|
107
|
+
- name: Upload distribution artifacts
|
|
108
|
+
uses: actions/upload-artifact@v4
|
|
109
|
+
with:
|
|
110
|
+
name: dist-files
|
|
111
|
+
path: dist/
|
|
112
|
+
retention-days: 5
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
name: Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags: ["v*"]
|
|
6
|
+
|
|
7
|
+
permissions:
|
|
8
|
+
contents: write
|
|
9
|
+
id-token: write
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
release:
|
|
13
|
+
name: Release to PyPI
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
environment:
|
|
16
|
+
name: pypi
|
|
17
|
+
url: https://pypi.org/p/opero
|
|
18
|
+
steps:
|
|
19
|
+
- name: Checkout code
|
|
20
|
+
uses: actions/checkout@v4
|
|
21
|
+
with:
|
|
22
|
+
fetch-depth: 0
|
|
23
|
+
|
|
24
|
+
- name: Set up Python
|
|
25
|
+
uses: actions/setup-python@v5
|
|
26
|
+
with:
|
|
27
|
+
python-version: "3.12"
|
|
28
|
+
|
|
29
|
+
- name: Install UV
|
|
30
|
+
uses: astral-sh/setup-uv@v5
|
|
31
|
+
with:
|
|
32
|
+
version: "latest"
|
|
33
|
+
python-version: "3.12"
|
|
34
|
+
enable-cache: true
|
|
35
|
+
|
|
36
|
+
- name: Install build tools
|
|
37
|
+
run: uv pip install build hatchling hatch-vcs
|
|
38
|
+
|
|
39
|
+
- name: Build distributions
|
|
40
|
+
run: uv run python -m build --outdir dist
|
|
41
|
+
|
|
42
|
+
- name: Verify distribution files
|
|
43
|
+
run: |
|
|
44
|
+
ls -la dist/
|
|
45
|
+
test -n "$(find dist -name '*.whl')" || (echo "Wheel file missing" && exit 1)
|
|
46
|
+
test -n "$(find dist -name '*.tar.gz')" || (echo "Source distribution missing" && exit 1)
|
|
47
|
+
|
|
48
|
+
- name: Publish to PyPI
|
|
49
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
50
|
+
with:
|
|
51
|
+
password: ${{ secrets.PYPI_TOKEN }}
|
|
52
|
+
|
|
53
|
+
- name: Create GitHub Release
|
|
54
|
+
uses: softprops/action-gh-release@v1
|
|
55
|
+
with:
|
|
56
|
+
files: dist/*
|
|
57
|
+
generate_release_notes: true
|
|
58
|
+
env:
|
|
59
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
opero-1.0.1/.gitignore
ADDED
|
@@ -0,0 +1,315 @@
|
|
|
1
|
+
*_autogen/
|
|
2
|
+
.DS_Store
|
|
3
|
+
__version__.py
|
|
4
|
+
__pycache__/
|
|
5
|
+
_Chutzpah*
|
|
6
|
+
_deps
|
|
7
|
+
_NCrunch_*
|
|
8
|
+
_pkginfo.txt
|
|
9
|
+
_Pvt_Extensions
|
|
10
|
+
_ReSharper*/
|
|
11
|
+
_TeamCity*
|
|
12
|
+
_UpgradeReport_Files/
|
|
13
|
+
!?*.[Cc]ache/
|
|
14
|
+
!.axoCover/settings.json
|
|
15
|
+
!.vscode/extensions.json
|
|
16
|
+
!.vscode/launch.json
|
|
17
|
+
!.vscode/settings.json
|
|
18
|
+
!.vscode/tasks.json
|
|
19
|
+
!**/[Pp]ackages/build/
|
|
20
|
+
!Directory.Build.rsp
|
|
21
|
+
.*crunch*.local.xml
|
|
22
|
+
.axoCover/*
|
|
23
|
+
.builds
|
|
24
|
+
.cr/personal
|
|
25
|
+
.fake/
|
|
26
|
+
.history/
|
|
27
|
+
.ionide/
|
|
28
|
+
.localhistory/
|
|
29
|
+
.mfractor/
|
|
30
|
+
.ntvs_analysis.dat
|
|
31
|
+
.paket/paket.exe
|
|
32
|
+
.sass-cache/
|
|
33
|
+
.vs/
|
|
34
|
+
.vscode
|
|
35
|
+
.vscode/*
|
|
36
|
+
.vshistory/
|
|
37
|
+
[Aa][Rr][Mm]/
|
|
38
|
+
[Aa][Rr][Mm]64/
|
|
39
|
+
[Bb]in/
|
|
40
|
+
[Bb]uild[Ll]og.*
|
|
41
|
+
[Dd]ebug/
|
|
42
|
+
[Dd]ebugPS/
|
|
43
|
+
[Dd]ebugPublic/
|
|
44
|
+
[Ee]xpress/
|
|
45
|
+
[Ll]og/
|
|
46
|
+
[Ll]ogs/
|
|
47
|
+
[Oo]bj/
|
|
48
|
+
[Rr]elease/
|
|
49
|
+
[Rr]eleasePS/
|
|
50
|
+
[Rr]eleases/
|
|
51
|
+
[Tt]est[Rr]esult*/
|
|
52
|
+
[Ww][Ii][Nn]32/
|
|
53
|
+
*_h.h
|
|
54
|
+
*_i.c
|
|
55
|
+
*_p.c
|
|
56
|
+
*_wpftmp.csproj
|
|
57
|
+
*- [Bb]ackup ([0-9]).rdl
|
|
58
|
+
*- [Bb]ackup ([0-9][0-9]).rdl
|
|
59
|
+
*- [Bb]ackup.rdl
|
|
60
|
+
*.[Cc]ache
|
|
61
|
+
*.[Pp]ublish.xml
|
|
62
|
+
*.[Rr]e[Ss]harper
|
|
63
|
+
*.a
|
|
64
|
+
*.app
|
|
65
|
+
*.appx
|
|
66
|
+
*.appxbundle
|
|
67
|
+
*.appxupload
|
|
68
|
+
*.aps
|
|
69
|
+
*.azurePubxml
|
|
70
|
+
*.bim_*.settings
|
|
71
|
+
*.bim.layout
|
|
72
|
+
*.binlog
|
|
73
|
+
*.btm.cs
|
|
74
|
+
*.btp.cs
|
|
75
|
+
*.build.csdef
|
|
76
|
+
*.cab
|
|
77
|
+
*.cachefile
|
|
78
|
+
*.code-workspace
|
|
79
|
+
*.coverage
|
|
80
|
+
*.coveragexml
|
|
81
|
+
*.d
|
|
82
|
+
*.dbmdl
|
|
83
|
+
*.dbproj.schemaview
|
|
84
|
+
*.dll
|
|
85
|
+
*.dotCover
|
|
86
|
+
*.DotSettings.user
|
|
87
|
+
*.dsp
|
|
88
|
+
*.dsw
|
|
89
|
+
*.dylib
|
|
90
|
+
*.e2e
|
|
91
|
+
*.exe
|
|
92
|
+
*.gch
|
|
93
|
+
*.GhostDoc.xml
|
|
94
|
+
*.gpState
|
|
95
|
+
*.ilk
|
|
96
|
+
*.iobj
|
|
97
|
+
*.ipdb
|
|
98
|
+
*.jfm
|
|
99
|
+
*.jmconfig
|
|
100
|
+
*.la
|
|
101
|
+
*.lai
|
|
102
|
+
*.ldf
|
|
103
|
+
*.lib
|
|
104
|
+
*.lo
|
|
105
|
+
*.log
|
|
106
|
+
*.mdf
|
|
107
|
+
*.meta
|
|
108
|
+
*.mm.*
|
|
109
|
+
*.mod
|
|
110
|
+
*.msi
|
|
111
|
+
*.msix
|
|
112
|
+
*.msm
|
|
113
|
+
*.msp
|
|
114
|
+
*.ncb
|
|
115
|
+
*.ndf
|
|
116
|
+
*.nuget.props
|
|
117
|
+
*.nuget.targets
|
|
118
|
+
*.nupkg
|
|
119
|
+
*.nvuser
|
|
120
|
+
*.o
|
|
121
|
+
*.obj
|
|
122
|
+
*.odx.cs
|
|
123
|
+
*.opendb
|
|
124
|
+
*.opensdf
|
|
125
|
+
*.opt
|
|
126
|
+
*.out
|
|
127
|
+
*.pch
|
|
128
|
+
*.pdb
|
|
129
|
+
*.pfx
|
|
130
|
+
*.pgc
|
|
131
|
+
*.pgd
|
|
132
|
+
*.pidb
|
|
133
|
+
*.plg
|
|
134
|
+
*.psess
|
|
135
|
+
*.publishproj
|
|
136
|
+
*.publishsettings
|
|
137
|
+
*.pubxml
|
|
138
|
+
*.pyc
|
|
139
|
+
*.rdl.data
|
|
140
|
+
*.rptproj.bak
|
|
141
|
+
*.rptproj.rsuser
|
|
142
|
+
*.rsp
|
|
143
|
+
*.rsuser
|
|
144
|
+
*.sap
|
|
145
|
+
*.sbr
|
|
146
|
+
*.scc
|
|
147
|
+
*.sdf
|
|
148
|
+
*.sln.docstates
|
|
149
|
+
*.sln.iml
|
|
150
|
+
*.slo
|
|
151
|
+
*.smod
|
|
152
|
+
*.snupkg
|
|
153
|
+
*.so
|
|
154
|
+
*.suo
|
|
155
|
+
*.svclog
|
|
156
|
+
*.tlb
|
|
157
|
+
*.tlh
|
|
158
|
+
*.tli
|
|
159
|
+
*.tlog
|
|
160
|
+
*.tmp
|
|
161
|
+
*.tmp_proj
|
|
162
|
+
*.tss
|
|
163
|
+
*.user
|
|
164
|
+
*.userosscache
|
|
165
|
+
*.userprefs
|
|
166
|
+
*.vbp
|
|
167
|
+
*.vbw
|
|
168
|
+
*.VC.db
|
|
169
|
+
*.VC.VC.opendb
|
|
170
|
+
*.VisualState.xml
|
|
171
|
+
*.vsp
|
|
172
|
+
*.vspscc
|
|
173
|
+
*.vspx
|
|
174
|
+
*.vssscc
|
|
175
|
+
*.xsd.cs
|
|
176
|
+
**/[Pp]ackages/*
|
|
177
|
+
**/*.DesktopClient/GeneratedArtifacts
|
|
178
|
+
**/*.DesktopClient/ModelManifest.xml
|
|
179
|
+
**/*.HTMLClient/GeneratedArtifacts
|
|
180
|
+
**/*.Server/GeneratedArtifacts
|
|
181
|
+
**/*.Server/ModelManifest.xml
|
|
182
|
+
*~
|
|
183
|
+
~$*
|
|
184
|
+
$tf/
|
|
185
|
+
AppPackages/
|
|
186
|
+
artifacts/
|
|
187
|
+
ASALocalRun/
|
|
188
|
+
AutoTest.Net/
|
|
189
|
+
Backup*/
|
|
190
|
+
BenchmarkDotNet.Artifacts/
|
|
191
|
+
bld/
|
|
192
|
+
BundleArtifacts/
|
|
193
|
+
ClientBin/
|
|
194
|
+
cmake_install.cmake
|
|
195
|
+
CMakeCache.txt
|
|
196
|
+
CMakeFiles
|
|
197
|
+
CMakeLists.txt.user
|
|
198
|
+
CMakeScripts
|
|
199
|
+
CMakeUserPresets.json
|
|
200
|
+
compile_commands.json
|
|
201
|
+
coverage*.info
|
|
202
|
+
coverage*.json
|
|
203
|
+
coverage*.xml
|
|
204
|
+
csx/
|
|
205
|
+
CTestTestfile.cmake
|
|
206
|
+
dlldata.c
|
|
207
|
+
DocProject/buildhelp/
|
|
208
|
+
DocProject/Help/*.hhc
|
|
209
|
+
DocProject/Help/*.hhk
|
|
210
|
+
DocProject/Help/*.hhp
|
|
211
|
+
DocProject/Help/*.HxC
|
|
212
|
+
DocProject/Help/*.HxT
|
|
213
|
+
DocProject/Help/html
|
|
214
|
+
DocProject/Help/Html2
|
|
215
|
+
ecf/
|
|
216
|
+
FakesAssemblies/
|
|
217
|
+
FodyWeavers.xsd
|
|
218
|
+
Generated_Code/
|
|
219
|
+
Generated\ Files/
|
|
220
|
+
healthchecksdb
|
|
221
|
+
install_manifest.txt
|
|
222
|
+
ipch/
|
|
223
|
+
Makefile
|
|
224
|
+
MigrationBackup/
|
|
225
|
+
mono_crash.*
|
|
226
|
+
nCrunchTemp_*
|
|
227
|
+
node_modules/
|
|
228
|
+
nunit-*.xml
|
|
229
|
+
OpenCover/
|
|
230
|
+
orleans.codegen.cs
|
|
231
|
+
Package.StoreAssociation.xml
|
|
232
|
+
paket-files/
|
|
233
|
+
project.fragment.lock.json
|
|
234
|
+
project.lock.json
|
|
235
|
+
publish/
|
|
236
|
+
PublishScripts/
|
|
237
|
+
rcf/
|
|
238
|
+
ScaffoldingReadMe.txt
|
|
239
|
+
ServiceFabricBackup/
|
|
240
|
+
StyleCopReport.xml
|
|
241
|
+
Testing
|
|
242
|
+
TestResult.xml
|
|
243
|
+
UpgradeLog*.htm
|
|
244
|
+
UpgradeLog*.XML
|
|
245
|
+
x64/
|
|
246
|
+
x86/
|
|
247
|
+
# Python
|
|
248
|
+
__pycache__/
|
|
249
|
+
*.py[cod]
|
|
250
|
+
*$py.class
|
|
251
|
+
*.so
|
|
252
|
+
.Python
|
|
253
|
+
build/
|
|
254
|
+
develop-eggs/
|
|
255
|
+
downloads/
|
|
256
|
+
eggs/
|
|
257
|
+
.eggs/
|
|
258
|
+
lib/
|
|
259
|
+
lib64/
|
|
260
|
+
parts/
|
|
261
|
+
sdist/
|
|
262
|
+
var/
|
|
263
|
+
wheels/
|
|
264
|
+
*.egg-info/
|
|
265
|
+
.installed.cfg
|
|
266
|
+
*.egg
|
|
267
|
+
MANIFEST
|
|
268
|
+
|
|
269
|
+
# Distribution / packaging
|
|
270
|
+
!dist/.gitkeep
|
|
271
|
+
|
|
272
|
+
# Unit test / coverage reports
|
|
273
|
+
htmlcov/
|
|
274
|
+
.tox/
|
|
275
|
+
.nox/
|
|
276
|
+
.coverage
|
|
277
|
+
.coverage.*
|
|
278
|
+
.cache
|
|
279
|
+
nosetests.xml
|
|
280
|
+
coverage.xml
|
|
281
|
+
*.cover
|
|
282
|
+
*.py,cover
|
|
283
|
+
.hypothesis/
|
|
284
|
+
.pytest_cache/
|
|
285
|
+
cover/
|
|
286
|
+
.ruff_cache/
|
|
287
|
+
|
|
288
|
+
# Environments
|
|
289
|
+
.env
|
|
290
|
+
.venv
|
|
291
|
+
env/
|
|
292
|
+
venv/
|
|
293
|
+
ENV/
|
|
294
|
+
env.bak/
|
|
295
|
+
venv.bak/
|
|
296
|
+
|
|
297
|
+
# IDE
|
|
298
|
+
.idea/
|
|
299
|
+
.vscode/
|
|
300
|
+
*.swp
|
|
301
|
+
*.swo
|
|
302
|
+
*~
|
|
303
|
+
|
|
304
|
+
# OS
|
|
305
|
+
.DS_Store
|
|
306
|
+
.DS_Store?
|
|
307
|
+
._*
|
|
308
|
+
.Spotlight-V100
|
|
309
|
+
.Trashes
|
|
310
|
+
ehthumbs.db
|
|
311
|
+
Thumbs.db
|
|
312
|
+
|
|
313
|
+
# Project specific
|
|
314
|
+
__version__.py
|
|
315
|
+
_private
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
repos:
|
|
2
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
3
|
+
rev: v0.3.4
|
|
4
|
+
hooks:
|
|
5
|
+
- id: ruff
|
|
6
|
+
args: [--fix]
|
|
7
|
+
- id: ruff-format
|
|
8
|
+
args: [--respect-gitignore]
|
|
9
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
10
|
+
rev: v4.5.0
|
|
11
|
+
hooks:
|
|
12
|
+
- id: trailing-whitespace
|
|
13
|
+
- id: end-of-file-fixer
|
|
14
|
+
- id: check-yaml
|
|
15
|
+
- id: check-toml
|
|
16
|
+
- id: check-added-large-files
|
|
17
|
+
- id: debug-statements
|
|
18
|
+
- id: check-case-conflict
|
|
19
|
+
- id: mixed-line-ending
|
|
20
|
+
args: [--fix=lf]
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
|
|
2
|
+
# SpecStory Artifacts Directory
|
|
3
|
+
|
|
4
|
+
This directory is automatically created and maintained by the SpecStory extension to preserve your Cursor composer and chat history.
|
|
5
|
+
|
|
6
|
+
## What's Here?
|
|
7
|
+
|
|
8
|
+
- `.specstory/history`: Contains markdown files of your AI coding sessions
|
|
9
|
+
- Each file represents a separate chat or composer session
|
|
10
|
+
- Files are automatically updated as you work
|
|
11
|
+
- `.specstory/cursor_rules_backups`: Contains backups of the `.cursor/rules/derived-cursor-rules.mdc` file
|
|
12
|
+
- Backups are automatically created each time the `.cursor/rules/derived-cursor-rules.mdc` file is updated
|
|
13
|
+
- You can enable/disable the Cursor Rules feature in the SpecStory settings
|
|
14
|
+
|
|
15
|
+
## Valuable Uses
|
|
16
|
+
|
|
17
|
+
- Capture: Keep your context window up-to-date when starting new Chat/Composer sessions via @ references
|
|
18
|
+
- Search: For previous prompts and code snippets
|
|
19
|
+
- Learn: Meta-analyze your patterns and learn from your past experiences
|
|
20
|
+
- Derive: Keep Cursor on course with your past decisions by automatically deriving Cursor rules from your AI interactions
|
|
21
|
+
|
|
22
|
+
## Version Control
|
|
23
|
+
|
|
24
|
+
We recommend keeping this directory under version control to maintain a history of your AI interactions. However, if you prefer not to version these files, you can exclude them by adding this to your `.gitignore`:
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
.specstory
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
We recommend not keeping the `.specstory/cursor_rules_backups` directory under version control if you are already using git to version the `.cursor/rules` directory, and committing regularly. You can exclude it by adding this to your `.gitignore`:
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
.specstory/cursor_rules_backups
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Searching Your Codebase
|
|
37
|
+
|
|
38
|
+
When searching your codebase in Cursor, search results may include your previous AI coding interactions. To focus solely on your actual code files, you can exclude the AI interaction history from search results.
|
|
39
|
+
|
|
40
|
+
To exclude AI interaction history:
|
|
41
|
+
|
|
42
|
+
1. Open the "Find in Files" search in Cursor (Cmd/Ctrl + Shift + F)
|
|
43
|
+
2. Navigate to the "files to exclude" section
|
|
44
|
+
3. Add the following pattern:
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
.specstory/*
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
This will ensure your searches only return results from your working codebase files.
|
|
51
|
+
|
|
52
|
+
## Notes
|
|
53
|
+
|
|
54
|
+
- Auto-save only works when Cursor/sqlite flushes data to disk. This results in a small delay after the AI response is complete before SpecStory can save the history.
|
|
55
|
+
- Auto-save does not yet work on remote WSL workspaces.
|
|
56
|
+
|
|
57
|
+
## Settings
|
|
58
|
+
|
|
59
|
+
You can control auto-saving behavior in Cursor:
|
|
60
|
+
|
|
61
|
+
1. Open Cursor → Settings → VS Code Settings (Cmd/Ctrl + ,)
|
|
62
|
+
2. Search for "SpecStory"
|
|
63
|
+
3. Find "Auto Save" setting to enable/disable
|
|
64
|
+
|
|
65
|
+
Auto-save occurs when changes are detected in Cursor's sqlite database, or every 2 minutes as a safety net.
|