First commit

custom_lib/README.md

@@ -0,0 +1,112 @@
+# Custom Lib
+
+My Custom Python Library.
+
+---
+
+## Features
+
+- File utility
+- Logger
+- UUID
+- Image utility
+- Crawling utility
+
+---
+
+## Requirements
+
+- Python 3.9+
+
+---
+
+## Note
+
+- Move `pyproject.toml` to the project directory.
+
+---
+
+## Install
+
+### Common
+
+```bash
+python -m pip install -e .
+```
+
+### Image
+
+```bash
+python -m pip install -e .[image]
+```
+
+### Crawling
+
+```bash
+python -m pip install -e .[crawling]
+```
+
+### All
+
+```bash
+python -m pip install -e .[all]
+```
+
+---
+
+## Usage
+
+```python
+from custom_lib import Custom_Lib as custom
+
+custom.init()
+```
+
+---
+
+## Modules
+
+| Module         | Description      |
+|----------------|------------------|
+| my_file_config | File utility     |
+| my_logger      | Logger           |
+| my_uuid        | UUID             |
+| my_image       | Image utility    |
+| my_crawling    | Crawling utility |
+
+---
+
+## Optional Dependencies
+
+| Option | Packages              |
+|---|-----------------------|
+| image | Pillow, OpenCV, Nump  |
+| crawling | Requests, BeautifulSoup |
+
+---
+
+## Project Structure
+
+```text
+custom_lib/
+├─ crawling/
+│  └─ __init__.py
+│  └─ my_crawling.py
+├─ image/
+│  └─ __init__.py
+│  └─ my_image.py
+├─ __init__.py
+├─ CHANGELOG.md
+├─ Custom_Lib.py
+├─ my_file_config.py
+├─ my_logger.py
+├─ my_uuid.py
+├─ pyproject.toml
+└─ README.md
+```
+
+---
+
+## Version
+
+### v1.0.4