Skip to content

Commit 117b252

Browse files
committed
Bump version to 0.1.1 and update README.md and PUBLISHING.md for clarity
- Updated version number in pyproject.toml from 0.1.0 to 0.1.1. - Enhanced README.md with additional details on features, benefits, and use cases. - Improved PUBLISHING.md with clearer instructions and formatting for publishing to PyPI.
1 parent b0311df commit 117b252

3 files changed

Lines changed: 23 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,12 +322,14 @@ pv index --smart /path/to/your/project
322322
```
323323

324324
**Features**:
325+
325326
- **Priority-based processing**: New files → Modified files → Deleted files
326327
- **Partial reindexing**: Only updates changed chunks (60-70% faster)
327328
- **Automatic detection**: Compares file content hashes to detect real changes
328329
- **Smart categorization**: Distinguishes between new, modified, and deleted files
329330

330331
**When to use**:
332+
331333
- Large codebases with frequent changes
332334
- After making targeted edits to specific files
333335
- When you want detailed statistics about what changed
@@ -351,12 +353,14 @@ pv index-git . --since HEAD~10
351353
```
352354

353355
**Benefits**:
356+
354357
- **Extremely fast**: Only processes files that actually changed in git
355358
- **Perfect for CI/CD**: Index only PR changes
356359
- **Branch-aware**: Compare against any branch or commit
357360
- **Automatic fallback**: Uses standard indexing if not a git repo
358361

359362
**Use cases**:
363+
360364
- After pulling changes from remote
361365
- Before code review (index only PR changes)
362366
- In CI/CD pipelines (index only new commits)
@@ -378,12 +382,14 @@ pv sync --watch --debounce 0.5 .
378382
```
379383

380384
**Debounce explained**:
385+
381386
- Waits specified seconds after last file change before indexing
382387
- Batches multiple rapid changes together
383388
- Prevents redundant indexing when saving files multiple times
384389
- Reduces CPU usage during active development
385390

386391
**Recommended debounce values**:
392+
387393
- **0.5-1.0s**: Fast machines, instant feedback needed
388394
- **2.0s** (default): Balanced performance
389395
- **5.0-10.0s**: Slower machines, large codebases
@@ -553,7 +559,7 @@ pv status /path/to/your/project
553559

554560
## Changelog
555561

556-
### v0.1.0
562+
### v0.1.1
557563

558564
- **Enhanced Single-Word Search**: Optimized search for single keywords with high precision
559565
- **Multi-Level Chunking**: Added micro-chunks and word-level chunks for better granularity

docs/PUBLISHING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This guide explains how to publish the project-vectorizer package to PyPI.
55
## Prerequisites
66

77
1. **PyPI Account**: Create accounts on both:
8+
89
- [TestPyPI](https://test.pypi.org/account/register/) (for testing)
910
- [PyPI](https://pypi.org/account/register/) (for production)
1011

@@ -19,20 +20,23 @@ This guide explains how to publish the project-vectorizer package to PyPI.
1920
This is the easiest method using GitHub Actions:
2021

2122
1. **Update Version Number**:
23+
2224
```bash
2325
# Edit pyproject.toml and update the version
2426
vim pyproject.toml
25-
# Change: version = "0.1.0" to version = "0.1.1"
27+
# Change: version = "0.1.1" to version = "0.1.2"
2628
```
2729

2830
2. **Commit and Push Changes**:
31+
2932
```bash
3033
git add pyproject.toml
3134
git commit -m "Bump version to 0.1.1"
3235
git push
3336
```
3437

3538
3. **Create a GitHub Release**:
39+
3640
```bash
3741
# Create and push a tag
3842
git tag v0.1.1
@@ -58,6 +62,7 @@ This is the easiest method using GitHub Actions:
5862
You can manually trigger a publish to TestPyPI or PyPI:
5963

6064
1. **Go to GitHub Actions**:
65+
6166
- Navigate to your repository → Actions tab
6267
- Select "Publish to PyPI" workflow
6368

@@ -73,11 +78,13 @@ You can manually trigger a publish to TestPyPI or PyPI:
7378
For local testing and publishing:
7479

7580
1. **Install Build Tools**:
81+
7682
```bash
7783
pip install build twine
7884
```
7985

8086
2. **Build the Package**:
87+
8188
```bash
8289
# Clean previous builds
8390
rm -rf dist/ build/ *.egg-info/
@@ -87,6 +94,7 @@ For local testing and publishing:
8794
```
8895

8996
3. **Test the Build**:
97+
9098
```bash
9199
# Check the package
92100
twine check dist/*
@@ -96,6 +104,7 @@ For local testing and publishing:
96104
```
97105

98106
4. **Upload to TestPyPI** (Testing):
107+
99108
```bash
100109
twine upload --repository testpypi dist/*
101110

@@ -186,18 +195,22 @@ rm -rf test_env
186195
### Common Issues:
187196

188197
1. **Version already exists**:
198+
189199
- You cannot re-upload the same version
190200
- Increment the version number in `pyproject.toml`
191201

192202
2. **Authentication failed**:
203+
193204
- Verify your API token or Trusted Publisher setup
194205
- Check GitHub Actions secrets
195206

196207
3. **Package not found**:
208+
197209
- Wait a few minutes after publishing
198210
- Check PyPI for the package page
199211

200212
4. **Import errors after install**:
213+
201214
- Verify MANIFEST.in includes all necessary files
202215
- Check that `__init__.py` files exist in all packages
203216

@@ -215,6 +228,7 @@ After publishing:
215228
## Support
216229

217230
For issues with publishing:
231+
218232
- Check [PyPI Help](https://pypi.org/help/)
219233
- Review [Python Packaging Guide](https://packaging.python.org/)
220234
- Open an issue in the repository

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "project-vectorizer"
7-
version = "0.1.0"
7+
version = "0.1.1"
88
description = "CLI tool for vectorizing codebases and serving them via MCP"
99
authors = [{name = "StarkBak", email = "bak.stark06@gmail.com"}]
1010
license = {text = "MIT"}

0 commit comments

Comments
 (0)