personal-projects/py-wikijs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: Rename package from wikijs-python-sdk to py-wikijs and migrate to GitHub

Browse Source 
Complete package renaming and platform migration:

Package Name Changes:
- Rename package from 'wikijs-python-sdk' to 'py-wikijs'
- Update setup.py package name
- Update pyproject.toml package name
- Users can now install with: pip install py-wikijs

URL Migration (Gitea → GitHub):
- Replace all Gitea URLs with GitHub URLs
- Update repository: github.com/l3ocho/py-wikijs
- Update issue tracker: github.com/l3ocho/py-wikijs/issues
- Update documentation links
- Fix URL path format (/src/branch/main/ → /blob/main/)

Documentation Updates:
- Update README.md badges (PyPI, GitHub)
- Update installation instructions (pip install py-wikijs)
- Update all doc references to new package name
- Update all examples with GitHub URLs
- Update DEPLOYMENT_READY.md with new package name
- Update deployment.md with new package name

Testing:
- Successfully built py_wikijs-0.1.0.tar.gz (138 KB)
- Successfully built py_wikijs-0.1.0-py3-none-any.whl (66 KB)
- Package installs correctly: pip install py-wikijs
- Imports work: from wikijs import WikiJSClient
- Package metadata correct (Home-page: github.com/l3ocho/py-wikijs)

Breaking Changes:
- Package name changed from wikijs-python-sdk to py-wikijs
- Repository migrated from Gitea to GitHub
- All URLs updated to GitHub

Users should now:
pip install py-wikijs  # Instead of wikijs-python-sdk

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Claude
2025-10-23 20:23:50 +00:00
parent c18d00cd47
commit 59cdf5ee01
52 changed files with 128 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
DEPLOYMENT_READY.md
View File

@@ -32,7 +32,7 @@
- [x] setup.py configured
- [x] pyproject.toml configured
- [x] Version management (wikijs/version.py)
- [x] Package name: `wikijs-python-sdk`
- [x] Package name: `py-wikijs`
- [x] Author information
- [x] Keywords and classifiers
- [x] Project URLs
@@ -48,7 +48,7 @@
## 📦 What's Included
### Source Distribution (`wikijs_python_sdk-0.1.0.tar.gz`)
### Source Distribution (`py_wikijs-0.1.0.tar.gz`)
```
Size: ~134 KB
@@ -65,7 +65,7 @@ Contents:
✅ pyproject.toml
```
### Wheel Distribution (`wikijs_python_sdk-0.1.0-py3-none-any.whl`)
### Wheel Distribution (`py_wikijs-0.1.0-py3-none-any.whl`)
```
Size: ~66 KB
@@ -97,7 +97,7 @@ python -m twine upload --repository testpypi dist/*
python -m twine upload dist/*
# 5. Install from PyPI
pip install wikijs-python-sdk
pip install py-wikijs
# Done! Package is now publicly available
```
@@ -106,10 +106,10 @@ pip install wikijs-python-sdk
```bash
# Users install directly from Git
pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git
pip install git+https://github.com/l3ocho/py-wikijs.git
# Or specific version/branch
pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git@v0.1.0
pip install git+https://github.com/l3ocho/py-wikijs.git@v0.1.0
```
---
@@ -119,13 +119,13 @@ pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git@v0.1.0
### Build Tests ✅
```bash
$ python -m build
Successfully built wikijs_python_sdk-0.1.0.tar.gz and wikijs_python_sdk-0.1.0-py3-none-any.whl
Successfully built py_wikijs-0.1.0.tar.gz and py_wikijs-0.1.0-py3-none-any.whl
```
### Installation Test ✅
```bash
$ pip install dist/wikijs_python_sdk-0.1.0-py3-none-any.whl
Successfully installed wikijs-python-sdk-0.1.0
$ pip install dist/py_wikijs-0.1.0-py3-none-any.whl
Successfully installed py-wikijs-0.1.0
```
### Import Test ✅
@@ -136,8 +136,8 @@ $ python -c "from wikijs import WikiJSClient, __version__; print(f'Version: {__v
### Dependency Test ✅
```bash
$ pip show wikijs-python-sdk
Name: wikijs-python-sdk
$ pip show py-wikijs
Name: py-wikijs
Version: 0.1.0
Requires: pydantic, requests, typing-extensions
Required-by:
@@ -149,7 +149,7 @@ Required-by:
| Attribute | Value |
|-----------|-------|
| **Package Name** | `wikijs-python-sdk` |
| **Package Name** | `py-wikijs` |
| **Import Name** | `wikijs` |
| **Version** | 0.1.0 |
| **Python Support** | 3.8+ |
@@ -240,7 +240,7 @@ Required-by:
## 📦 PyPI vs Gitea-Only
### PyPI Benefits
- ✅ Simple installation: `pip install wikijs-python-sdk`
- ✅ Simple installation: `pip install py-wikijs`
- ✅ Better discoverability
- ✅ Automatic dependency resolution
- ✅ Version management