Skip to content

Commit ffdd8bd

Browse files
committed
chore: Remove examples from CI and tooling paths
1 parent 60e158b commit ffdd8bd

File tree

8 files changed

+36
-23
lines changed

8 files changed

+36
-23
lines changed

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,11 @@ jobs:
8989
9090
- name: Check formatting
9191
run: |
92-
black --check src tests examples
92+
black --check src tests
9393
9494
- name: Check import sorting
9595
run: |
96-
isort --check-only --diff src tests examples
96+
isort --check-only --diff src tests
9797
9898
- name: Type check
9999
run: |

.github/workflows/test.yml

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ jobs:
6868
6969
- name: Check formatting with black
7070
run: |
71-
black --check src tests examples
71+
black --check src tests
7272
7373
- name: Check import sorting with isort
7474
run: |
75-
isort --check-only --diff src tests examples
75+
isort --check-only --diff src tests
7676
7777
- name: Type check with mypy
7878
run: |
@@ -112,9 +112,28 @@ jobs:
112112
python -m pip install --upgrade pip
113113
pip install -e ".[dev,sqlalchemy,fuzzy]"
114114
115-
- name: Run integration tests
115+
- name: Redis integration smoke
116116
run: |
117-
python examples/basic_usage.py
117+
python -c "
118+
import asyncio
119+
import os
120+
from yokedcache import YokedCache
121+
from yokedcache.config import CacheConfig
122+
123+
async def main():
124+
url = os.environ.get('YOKEDCACHE_REDIS_URL', 'redis://127.0.0.1:6379/0')
125+
c = YokedCache(CacheConfig(redis_url=url))
126+
await c.connect()
127+
await c.set('ci_smoke', {'ok': True}, ttl=60)
128+
v = await c.get('ci_smoke')
129+
assert v == {'ok': True}, v
130+
await c.delete('ci_smoke')
131+
await c.disconnect()
132+
133+
asyncio.run(main())
134+
"
135+
env:
136+
YOKEDCACHE_REDIS_URL: redis://127.0.0.1:6379/0
118137
- name: Test CLI
119138
run: |
120139
python -m yokedcache ping

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ repos:
1818
hooks:
1919
- id: mypy
2020
args: [--ignore-missing-imports, --no-strict-optional, --disable-error-code=unused-ignore]
21-
exclude: ^(scripts/|examples/)
21+
exclude: ^scripts/
2222
additional_dependencies:
2323
- types-PyYAML
2424
- types-redis

CONTRIBUTING.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ Run all checks before committing:
5858

5959
```bash
6060
# Format code
61-
black src tests examples
62-
isort src tests examples
61+
black src tests
62+
isort src tests
6363

6464
# Check linting
65-
flake8 src tests examples
65+
flake8 src tests
6666

6767
# Type checking
6868
mypy src --ignore-missing-imports
@@ -97,7 +97,6 @@ pytest tests/test_cache.py::TestYokedCache::test_basic_get_set
9797
- Update docstrings for all public functions and classes
9898
- Follow Google-style docstring format
9999
- Update README.md for new features
100-
- Add examples to the `examples/` directory
101100
- Update guides under `site-src/pages/` when you change user-facing behavior
102101
- Run `pip install -e ".[docs]"` then `python scripts/build_docs_site.py` to verify the static site builds
103102
- Preview: `cd site && python -m http.server 8000` (after copying `CHANGELOG.md` to `site/changelog.md` for the changelog page)
@@ -138,8 +137,8 @@ For new features:
138137
5. **Run the test suite** and ensure all tests pass:
139138
```bash
140139
pytest
141-
black src tests examples
142-
flake8 src tests examples
140+
black src tests
141+
flake8 src tests
143142
mypy src --ignore-missing-imports
144143
python scripts/build_docs_site.py
145144
```
@@ -195,7 +194,6 @@ yokedcache/
195194
│ ├── exceptions.py # Custom exceptions
196195
│ └── cli.py # Command-line interface
197196
├── tests/ # Test suite
198-
├── examples/ # Usage examples
199197
├── site-src/ # Static site sources (Markdown, templates, assets)
200198
└── pyproject.toml # Project configuration
201199
```
@@ -214,7 +212,7 @@ yokedcache/
214212

215213
## Getting Help
216214

217-
- **Documentation:** Check the README and examples
215+
- **Documentation:** Check the README and the docs site
218216
- **Issues:** Search existing issues or create a new one
219217
- **Discussions:** Use GitHub Discussions for questions
220218
- **Chat:** Join our community chat (link TBD)

MANIFEST.in

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ include CHANGELOG.md
55
include CONTRIBUTING.md
66
include requirements-*.txt
77

8-
# Include configuration examples
9-
recursive-include examples *.py *.yaml *.yml *.md
10-
118
# Include tests (optional, for source distributions)
129
recursive-include tests *.py
1310

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ test-cov:
5454

5555
# Code quality
5656
lint:
57-
flake8 src tests examples
57+
flake8 src tests
5858
mypy src
5959

6060
format:
61-
black src tests examples
62-
isort src tests examples
61+
black src tests
62+
isort src tests
6363

6464
type-check:
6565
mypy src

codecov.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ comment:
3939

4040
ignore:
4141
- "tests/"
42-
- "examples/"
4342
- "site-src/"
4443
- "site/"
4544
- "htmlcov/"

site-src/pages/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -530,7 +530,7 @@ redis-cli --latency
530530
## Getting Help
531531

532532
- **Documentation**: Explore the full documentation for detailed guides
533-
- **Examples**: Check the `examples/` directory for complete working examples
533+
- **Examples**: See the [FastAPI tutorial](tutorials/fastapi.html) and [usage patterns](usage-patterns.html)
534534
- **CLI Help**: Run `yokedcache --help` for command-line assistance
535535
- **Issues**: Report bugs or request features on GitHub
536536

0 commit comments

Comments
 (0)