Warning
This package is for personal use by seefs. Use at your own risk. The author takes no responsibility for any issues arising from its usage and will not provide support or bug fixes for external users.
Caution
By using this package, you acknowledge that you are doing so at your own risk and without any expectation of support or maintenance from the author.
xox is a comprehensive Golang utility package that aggregates multiple sub-packages, each designed to provide specific functionalities without introducing third-party dependencies. Inspired by various sources, xox aims to streamline everyday development tasks with clean and efficient solutions.
- No third-party dependencies: All functionalities are implemented using the Golang standard library.
- Lightweight: Includes only the most commonly used and practical utility functions.
- Easy to use: Clean API design for seamless integration into existing projects.
- Continuous improvement: Constantly refined and expanded based on real-world usage.
| Package | Description | Status | Example | Test File | Documentation |
|---|---|---|---|---|---|
| x | Core utility methods for various workflows | 🚧 Working | Test | Docs | |
| xai | AI-related functionalities | 🚧 Alpha | Example | 🚧 To be added | Docs |
| xcast | Type conversion utilities | 🚧 Alpha | Test | Docs | |
| xcli | CLI application building tools | 🚧 Alpha | Example | 🚧 To be added | Docs |
| xcolor | Color-related utilities | 🚧 Alpha | 🚧 To be added | Docs | |
| xconfig | Configuration management | 🚧 Alpha | Test | Docs | |
| xd | Dependency injection | 🚧 Alpha | Test | Docs | |
| xenv | Environment variable handling | 🚧 Alpha | 🚧 To be added | Docs | |
| xerror | Error handling and processing | Example | Test | Docs | |
| xhttp | HTTP server standard library helpers | 🚧 Alpha | Example | 🚧 To be added | Docs |
| xhttpc | HTTP client standard library helpers | 🚧 Alpha | Test | Docs | |
| xjson | JSON path data retrieval | Test | Docs | ||
| xlog | Logging utilities with various handlers | 🚧 Alpha | Example | Test | Docs |
| xmw | Middleware for standard HTTP servers | 🚧 Alpha | Example | Test | Docs |
| xsb | SQL builder for database interactions | 🚧 Working | Test | Docs | |
| xsched | Task scheduling utilities | 🚧 Working | Example | Test | Docs |
| xsupabase | Supabase integration | 🚧 Alpha | Example | Test | Docs |
| xtelebot | Telegram bot API integration | 🚧 Alpha | Example | 🚧 To be added | Docs |
| xvalidator | Data validation utilities | Test | Docs | ||
| xtime | Time handling utilities | 🚧 Alpha | Test | Docs | |
| xresend | Go client for Resend API | 🚧 Alpha | Example | Docs |
To use xox and its sub-packages, follow these steps:
-
Install the package using go get:
go get github.com/seefs001/xox -
Import the desired sub-package in your Go code:
import "github.com/seefs001/xox/x"
-
Use the provided utilities as needed in your project.
Each sub-package comes with its own set of examples demonstrating how to use its functionalities. You can find the examples in the examples/ directory of the repository.
Each sub-package includes unit tests to ensure functionality and reliability. Tests can be found alongside their respective packages.
To run all tests, navigate to the root directory and execute:
go test ./...
While this package is primarily for personal use, contributions are welcome. Please ensure you follow the existing code style and include appropriate tests for any new functionality.
This project is licensed under the MIT License - see the LICENSE file for details.
- Inspired by various open-source projects and utility libraries in the Go ecosystem.
