Skip to content

Commit e810126

Browse files
committed
v1.1 readme last update
1. reworded build with source description 2. tests section at the end no develop and test
1 parent ac4878e commit e810126

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ pip install python-alfresco-api
111111

112112
### Development with source
113113

114-
For development your project with source of python-alfresco-api for debugging
114+
For development of your project using python-alfresco-api to have debugging with source:
115115

116116
```bash
117117
# After setting up virtual environment above
@@ -460,7 +460,27 @@ await event_client.start_listening()
460460
For complete development documentation including the **3-step generation process** (Pydantic models → HTTP clients → High-level APIs), see **[📖 Package Developers Guide](docs/PACKAGE_DEVELOPERS_GUIDE.md)**.
461461

462462

463-
## 🧪 Testing
463+
## 🧪 Development and Testing
464+
465+
### Development Setup
466+
467+
For development, testing, and contributing:
468+
469+
```bash
470+
pip install -r requirements-dev.txt
471+
```
472+
473+
For most development work on python-alfresco-api, you can develop directly without regenerating code:
474+
475+
```bash
476+
git clone https://github.com/stevereiner/python-alfresco-api.git
477+
cd python-alfresco-api
478+
479+
# Install in development mode
480+
pip install -e .
481+
```
482+
483+
> **Note**: For proper pytest execution, work from the source directory with `pip install -e .` rather than testing from separate directories. This avoids import path conflicts.
464484
465485
### Run Tests
466486

@@ -473,8 +493,16 @@ pytest
473493
# Run all tests with coverage
474494
pytest --cov=python_alfresco_api --cov-report=html
475495

476-
# Or use the custom test runner for enhanced output
496+
# Custom test runner with additional features
477497
python run_tests.py
498+
# Features:
499+
# - Environment validation (venv, dependencies)
500+
# - Colored output with progress tracking
501+
# - Test selection for 44%+ coverage baseline
502+
# - Performance metrics (client creation speed)
503+
# - Live Alfresco server detection
504+
# - HTML coverage reports (htmlcov/index.html)
505+
# - Test summary with next steps
478506
```
479507

480508
### Live Integration Tests

0 commit comments

Comments
 (0)