|
28 | 28 |
|
29 | 29 | ### **Installation** |
30 | 30 | ```bash |
| 31 | +# ====================== |
31 | 32 | # Clone repository |
| 33 | +# ====================== |
32 | 34 | git clone https://github.com/SSobol77/csv-db-sdk.git |
33 | 35 | cd csv-db-sdk |
34 | 36 |
|
35 | | -# Install dependencies |
36 | | -pip install -r requirements.txt |
| 37 | +# ====================== |
| 38 | +# Installation Guide |
| 39 | +# ====================== |
| 40 | + |
| 41 | +### Basic Installation (Core Functionality) |
| 42 | +pip install csv-db-sdk |
| 43 | + |
| 44 | +### Development Setup (Testing + Coverage) |
| 45 | +pip install "csv-db-sdk[testing]" |
| 46 | + |
| 47 | +### Full Installation (All Features) |
| 48 | +pip install "csv-db-sdk[full]" |
| 49 | + |
| 50 | +# ====================== |
| 51 | +# Semantic Versioning Policy |
| 52 | +# ====================== |
| 53 | + |
| 54 | +### Dependency Management |
| 55 | +Strict SemVer compliance for all dependencies: |
| 56 | +psycopg2-binary ~= 2.9.9 # Compatible with 2.9.x (2.9.9 ≤ version < 3.0) |
| 57 | +boto3 ~= 1.34.112 # Compatible with 1.34.x (1.34.112 ≤ version < 2.0) |
| 58 | + |
| 59 | +### Version Guarantees |
| 60 | +- Major versions (X.0.0): Breaking API changes |
| 61 | +- Minor versions (1.X.0): Backwards-compatible features |
| 62 | +- Patch versions (1.0.X): Backwards-compatible bug fixes |
| 63 | + |
| 64 | +### Compatibility Matrix |
| 65 | +| Component | Supported Versions | Stability Level | |
| 66 | +|-----------------|--------------------|-----------------| |
| 67 | +| PostgreSQL | 12-16 | Production | |
| 68 | +| MySQL | 5.7-8.1 | Production | |
| 69 | +| Oracle DB | 19c-23c | Verified | |
| 70 | +| MongoDB | 4.4-7.0 | Production | |
| 71 | + |
| 72 | +# ====================== |
| 73 | +# Upgrade Recommendations |
| 74 | +# ====================== |
| 75 | + |
| 76 | +### Safe Upgrade Path |
| 77 | +pip install --upgrade-strategy eager "csv-db-sdk>=1.2,<2.0" |
| 78 | + |
| 79 | +### Version Pinning Example |
| 80 | +echo "csv-db-sdk==1.2.3" >> production-requirements.txt |
| 81 | + |
37 | 82 | ``` |
38 | 83 |
|
39 | 84 | ### **Basic Usage** |
|
0 commit comments