diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9af1cdc --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# Changelog + +## v1.0.3 +- Added `my_crawling.py` +- Deleted `__pycache__` + +## v1.0.2 +- Modified print style +- Added my_image version and comment +- Added my_image function +- Added my image.py + +## v1.0.1 +- First commit \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..3b1d8d5 --- /dev/null +++ b/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.3 \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..c1f5fb4 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,33 @@ +[project] +name = "custom_lib" +version = "1.0.3" +description = "My Custom Python Library" +requires-python = ">=3.9" + +# --- required --- +dependencies = [] + +# --- optional --- +[project.optional-dependencies] +image = [ + "webcolors==1.13", + "pillow==9.4.0", + "opencv-contrib-python==4.5.2.52", + "numpy<2" +] +crawling = [ + "requests==2.26.0", + "beautifulsoup4==4.11.2" +] +all = [ + "webcolors==1.13", + "pillow==9.4.0", + "opencv-contrib-python==4.5.2.52", + "numpy<2", + "requests==2.26.0", + "beautifulsoup4==4.11.2" +] + +# --- path --- +[tool.setuptools.packages.find] +include = ["custom_lib*"] \ No newline at end of file