Skip to content

Commit 811bb5b

Browse files
committed
docs: translate Dutch content to English, fix monorepo URLs
1 parent 36fb44e commit 811bb5b

2 files changed

Lines changed: 25 additions & 22 deletions

File tree

PUBLISHING.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,27 @@
44

55
```
66
src/sdk/
7-
├── pyproject.toml # Package metadata, dependencies, build config
8-
├── README.md # Documentation (shown on PyPI)
9-
├── CHANGELOG.md # Version history
10-
├── LICENSE # MIT License
11-
├── .gitignore # Git ignore rules
127
├── __init__.py # Package root with version and exports
138
├── core/ # Core infrastructure
149
├── models/ # ORM models
1510
└── repositories/ # Data access layer
1611
```
1712

13+
```
14+
(repo root)
15+
├── pyproject.toml # Package metadata, dependencies, build config
16+
├── README.md # Documentation (shown on PyPI)
17+
├── CHANGELOG.md # Version history
18+
├── LICENSE # MIT License
19+
└── .gitignore # Git ignore rules
20+
```
21+
1822
## Local Development
1923

2024
### Install in editable mode
2125

2226
```bash
23-
cd d:\repos\ITL.ControlPlane.Attestation\src\sdk
27+
cd d:\repos\ITL.ControlPlane.Attestation.Sdk
2428
pip install -e ".[dev]"
2529
```
2630

@@ -46,7 +50,7 @@ pip install build twine
4650
### Build wheel and sdist
4751

4852
```bash
49-
cd d:\repos\ITL.ControlPlane.Attestation\src\sdk
53+
cd d:\repos\ITL.ControlPlane.Attestation.Sdk
5054
python -m build
5155
```
5256

@@ -130,7 +134,7 @@ Add new version section:
130134
### 3. Commit and tag
131135

132136
```bash
133-
git add src/sdk/__init__.py src/sdk/CHANGELOG.md
137+
git add src/sdk/__init__.py CHANGELOG.md
134138
git commit -m "chore: bump version to 0.2.0"
135139
git tag v0.2.0
136140
git push origin main --tags
@@ -139,7 +143,6 @@ git push origin main --tags
139143
### 4. Build and publish
140144

141145
```bash
142-
cd src/sdk
143146
rm -rf dist/ # Clean old builds
144147
python -m build
145148
twine check dist/*
@@ -215,7 +218,7 @@ jobs:
215218
- **Version**: `0.1.0`
216219
- **License**: MIT
217220
- **Python**: `>=3.10`
218-
- **Homepage**: https://github.com/ITLusions/ITL.ControlPlane.Attestation
221+
- **Homepage**: https://github.com/ITLusions/ITL.ControlPlane.Attestation.Sdk
219222
- **Author**: ITLusions <info@itlusions.com>
220223

221224
## Dependencies

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ pip install itl-attestation-sdk
2828

2929
```bash
3030
# Clone the repository
31-
git clone https://github.com/ITLusions/ITL.ControlPlane.Attestation.git
32-
cd ITL.ControlPlane.Attestation/src/sdk
31+
git clone https://github.com/ITLusions/ITL.ControlPlane.Attestation.Sdk.git
32+
cd ITL.ControlPlane.Attestation.Sdk
3333

3434
# Install in editable mode with dev dependencies
3535
pip install -e ".[dev]"
@@ -109,10 +109,10 @@ print(f"Found {len(attested)} attested machines")
109109

110110
```
111111
sdk/
112-
├── core/ # Core infrastructuur
112+
├── core/ # Core infrastructure
113113
│ ├── config.py # AttestationConfig (Pydantic BaseSettings)
114114
│ ├── database.py # SQLAlchemy engine, async session factory
115-
│ ├── exceptions.py # SDK excepties
115+
│ ├── exceptions.py # SDK exception hierarchy
116116
│ └── __init__.py # Core exports
117117
├── models/ # ORM models (SQLModel)
118118
│ ├── machine.py # MachineRow, NodeRole, MachineStatus
@@ -126,9 +126,9 @@ sdk/
126126
127127
```
128128

129-
## Gebruik
129+
## Usage
130130

131-
### Basis import
131+
### Basic import
132132

133133
```python
134134
from sdk import (
@@ -140,10 +140,10 @@ from sdk import (
140140
get_session,
141141
)
142142

143-
# Configuratie
144-
print(config.db_url) # sqlite:///d:/repos/.../data/machines.db
143+
# Configuration
144+
print(config.db_url) # sqlite:///./data/machines.db
145145

146-
# Database sessie
146+
# Database session
147147
async with get_session() as session:
148148
repo = SqlMachineRepository(session)
149149
machine = repo.get_by_id("a1b2c3d4-...")
@@ -155,7 +155,7 @@ async with get_session() as session:
155155
```python
156156
from sdk.models import MachineRow, MachineStatus, NodeRole
157157

158-
# Nieuwe machine aanmaken
158+
# Create a new machine
159159
machine = MachineRow(
160160
machine_id="a1b2c3d4-...",
161161
ek_fingerprint="SHA384:...",
@@ -222,8 +222,8 @@ Or via a `.env` file loaded with `python-dotenv`.
222222

223223
```bash
224224
# Clone and install
225-
git clone https://github.com/ITLusions/ITL.ControlPlane.Attestation.git
226-
cd ITL.ControlPlane.Attestation/src/sdk
225+
git clone https://github.com/ITLusions/ITL.ControlPlane.Attestation.Sdk.git
226+
cd ITL.ControlPlane.Attestation.Sdk
227227
pip install -e ".[dev]"
228228
```
229229

0 commit comments

Comments
 (0)