Added complete configuration support with multiple formats and examples
to help users easily configure py-wikijs for their projects.
New Features:
- Configuration file templates for ENV, YAML, JSON, and INI formats
- config_helper.py: Universal configuration loader and client factory
* Auto-detects and loads configs from multiple formats
* Supports environment variables, YAML, JSON, and INI files
* Provides create_client_from_config() for easy client creation
* Validates configuration and provides helpful error messages
Configuration Templates:
- config.env.example: Environment variables (Docker, 12-factor apps)
- config.yaml.example: YAML with multi-environment support
- config.json.example: JSON for programmatic configuration
- config.ini.example: INI for traditional setups
Usage Examples:
- using_env_config.py: Complete example using .env files
- using_yaml_config.py: Complete example using YAML configuration
- using_json_config.py: Complete example using JSON configuration
Documentation:
- docs/CONFIGURATION_GUIDE.md: Comprehensive configuration guide
* All configuration methods explained
* Security best practices
* Environment-specific configurations
* Troubleshooting guide
Benefits:
✅ Flexible configuration (choose your preferred format)
✅ Keep credentials secure (no hardcoding)
✅ Environment-specific configs (dev/staging/prod)
✅ Docker/container-ready
✅ Full validation and error handling
✅ Comprehensive documentation and examples
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Added comprehensive documentation to help users install and test
py-wikijs in their projects before public release.
Changes:
- INSTALLATION_GUIDE.md: Complete guide for all installation methods
* GitHub installation (recommended for now)
* requirements.txt integration
* pyproject.toml integration
* Local development setup
* Usage examples and troubleshooting
- examples/quick_test.py: Verification script
* Tests package import
* Tests Wiki.js connectivity (optional)
* Validates feature availability
* Provides clear diagnostic output
This prepares the package for testing in external projects before
making the repository public.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Comprehensive documentation updates for v0.2.0 release features:
Documentation Updates:
- Updated CHANGELOG.md with v0.2.0 release notes documenting:
* Async/await support with AsyncWikiJSClient
* Intelligent caching layer with MemoryCache
* Batch operations (create_many, update_many, delete_many)
* Complete API coverage (Users, Groups, Assets, System)
* Performance improvements and test coverage increases
- Updated docs/api_reference.md with:
* Caching section documenting MemoryCache interface and usage
* Batch Operations section with all three methods
* Cache invalidation and statistics tracking
- Updated docs/user_guide.md with:
* Intelligent Caching section with practical examples
* Completely rewritten Batch Operations section
* Performance comparison examples and use cases
- Updated README.md:
* Replaced generic features with specific implemented capabilities
* Added Async Support, Intelligent Caching, Batch Operations
* Updated current features to reflect v0.2.0 status
New Example Files:
- examples/caching_example.py (196 lines):
* Basic caching usage and configuration
* Cache statistics and hit rate monitoring
* Automatic and manual cache invalidation
* Shared cache across operations
* Cache cleanup and management
- examples/batch_operations.py (289 lines):
* Batch page creation with performance comparison
* Bulk updates and partial failure handling
* Batch deletion with success/failure tracking
* Data migration patterns
* Performance benchmarks (sequential vs batch)
All documentation is now complete and ready for merge to development branch.
Test coverage: 81% (up from 43%)
All tests passing: 37 tests (27 cache + 10 batch operations)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
