Skip to content

Commit 4feaa46

Browse files
readme fixes
1 parent 86edd22 commit 4feaa46

File tree

2 files changed

+10
-41
lines changed

2 files changed

+10
-41
lines changed

DEVELOPMENT.md

Lines changed: 9 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,14 @@ source venv/bin/activate # On Windows: venv\Scripts\activate
2121
### Step 3: Install in Development Mode
2222

2323
```bash
24-
pip install -e .
24+
pip install -e . && python -m superclient install_pth
2525
```
2626

27-
This installs the package in "editable" mode, which means:
27+
This installs the package in "editable" mode and enables automatic loading, which means:
2828
- Changes to the source code are immediately reflected without reinstalling
2929
- The package is installed in your Python environment
3030
- You can import and use the package normally
31-
32-
### Step 4: Enable Automatic Loading
33-
34-
To test the automatic loading functionality:
35-
36-
```bash
37-
python -m superclient install_pth
38-
```
39-
40-
This installs the `.pth` file that enables automatic loading when Python starts.
31+
- The `.pth` file is installed to enable automatic loading when Python starts
4132

4233
## Development Workflow
4334

@@ -50,26 +41,12 @@ This installs the `.pth` file that enables automatic loading when Python starts.
5041

5142
## Uninstallation
5243

53-
### Step 1: Remove the .pth File (if installed)
54-
5544
```bash
56-
# Find and remove the .pth file
57-
find venv/lib/python*/site-packages -name "superclient-init.pth" -delete
45+
pip uninstall superclient && find venv/lib/python*/site-packages -name "superclient-init.pth" -delete && rm -rf build/ dist/ superclient.egg-info/ && find . -name "*.pyc" -delete && find . -name "__pycache__" -type d -exec rm -rf {} +
5846
```
5947

60-
### Step 2: Uninstall the Package
61-
62-
```bash
63-
pip uninstall superclient
64-
```
65-
66-
### Step 3: Clean Up Build Artifacts
67-
68-
```bash
69-
# Remove build directories
70-
rm -rf build/ dist/ superclient.egg-info/
71-
72-
# Remove any cached Python files
73-
find . -name "*.pyc" -delete
74-
find . -name "__pycache__" -type d -exec rm -rf {} +
75-
```
48+
This single command:
49+
1. Uninstalls the superclient package
50+
2. Removes the .pth file
51+
3. Cleans up build artifacts
52+
4. Removes cached Python files

README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,8 @@ The Superstream library needs to modify your producer's configuration to apply o
7979

8080
## Installation
8181

82-
### Step 1: Install Superclient
83-
8482
```bash
85-
# Step 1: Install the package
86-
pip install superclient
87-
88-
# Step 2: One-time setup (enables automatic loading)
89-
python -m superclient install_pth
83+
pip install superclient && python -m superclient install_pth
9084
```
9185

9286
That's it! Superclient will now automatically load and optimize all Kafka producers in your Python environment.
@@ -121,8 +115,6 @@ FROM python:3.8-slim
121115

122116
# Install superclient
123117
RUN pip install superclient
124-
125-
# Run the one-time setup to enable automatic loading
126118
RUN python -m superclient install_pth
127119

128120
# Your application code

0 commit comments

Comments
 (0)