addpath

Name	addpath JSON
Version	0.1.0 JSON
	download
home_page	https://github.com/noggong/addpath
Summary	Automatically add parent directories to sys.path in Python
upload_time	2025-02-11 02:45:53
maintainer	None
docs_url	None
author	Your Name
requires_python	>=3.6
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            ### **📌 `addpath` 패키지 README (Markdown 형식, 한글 버전)**  
📢 **이 패키지는 Python에서 상위 디렉토리를 자동으로 `sys.path`에 추가하여, 불필요한 `sys.path.insert()` 호출을 줄이는 것을 목표로 합니다.**  

```markdown
# 📌 addpath - Python에서 자동으로 상위 디렉토리를 추가하는 패키지

## 🚀 소개
`addpath`는 Python에서 **상위 디렉토리를 자동으로 `sys.path`에 추가**하는 유틸리티 패키지입니다.  
더 이상 `sys.path.insert(0, "..")` 같은 코드를 반복해서 작성할 필요가 없습니다!

## 📌 설치 방법
PyPI에서 바로 설치할 수 있습니다.

```sh
pip install addpath
```

또는 GitHub에서 직접 설치할 수도 있습니다.

```sh
pip install git+https://github.com/noggong/addpath.git
```

---

## 🚀 사용법
### **1️⃣ 기본 사용법**
```python
import addpath

# 현재 스크립트의 상위 디렉토리를 sys.path에 추가
addpath.add_parent_path()
```
✅ **이제 상위 디렉토리에 있는 모듈을 바로 import할 수 있습니다!**

### **2️⃣ 특정 레벨의 상위 디렉토리 추가**
기본적으로 `add_parent_path()` 함수는 **현재 실행 중인 파일의 1단계 상위 디렉토리를 `sys.path`에 추가**합니다.  
그러나, 더 상위 디렉토리를 추가하고 싶다면 `levels` 값을 조정하면 됩니다.

```python
# 상위 디렉토리 2단계 추가
addpath.add_parent_path(levels=2)
```
✅ **이제 두 단계 위에 있는 패키지도 `import`할 수 있습니다.**

---

## 📌 예제 프로젝트 구조
```sh
my_project/
│── main.py
│── src/
│   │── my_module.py
```

📌 **예제 코드 (`src/my_module.py`)**
```python
def hello():
    return "안녕하세요! addpath를 사용하면 편리해요."
```

📌 **main.py에서 `my_module.py`를 import하는 방법**
```python
import addpath
addpath.add_parent_path()

import my_module
print(my_module.hello())  # "안녕하세요! addpath를 사용하면 편리해요."
```

✅ **더 이상 `sys.path.insert()`를 반복해서 추가할 필요가 없습니다!**

---

## 📌 자동으로 `sys.path`를 설정해야 하는 경우
- **프로젝트 구조가 복잡한 경우**
- **테스트 코드에서 부모 디렉토리의 모듈을 불러와야 할 때**
- **Jupyter Notebook에서 외부 모듈을 쉽게 불러오고 싶을 때**
- **Python 스크립트 실행 시 불필요한 `sys.path.append()` 코드 없이 실행하고 싶을 때**

---

## 🚀 기능 정리
✔ `add_parent_path(levels=1)` → 현재 디렉토리의 `levels`만큼 상위 디렉토리를 `sys.path`에 추가  
✔ `pip install addpath` → 어디서든 간편하게 설치 후 사용 가능  
✔ Python 3.6 이상 지원 🚀  

---

## 📌 라이선스
이 프로젝트는 **MIT 라이선스**로 제공됩니다. 자유롭게 사용 및 수정할 수 있습니다.  

---

## 📌 기여 방법
`addpath` 프로젝트에 기여하고 싶다면, GitHub에서 Fork 후 PR을 보내주세요! 🚀  
```sh
git clone https://github.com/yourusername/addpath.git
cd addpath
pip install -e .
```

✅ **이제 개발 환경에서 `addpath`를 테스트하고 개선할 수 있습니다.** 🚀🔥  

---

📌 **이제 Python 프로젝트에서 `sys.path` 문제를 간단하게 해결하세요!** 🚀
```

✅ **Markdown 문법이 적용된 README로, 바로 GitHub이나 PyPI에서 사용 가능합니다!** 🚀🔥

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/noggong/addpath",
    "name": "addpath",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Your Name",
    "author_email": "your.email@example.com",
    "download_url": "https://files.pythonhosted.org/packages/24/13/a569d31d0cf122a1beaa6a10419dab7cbf3d9e9aa6ab77b9230884216aba/addpath-0.1.0.tar.gz",
    "platform": null,
    "description": "### **\ud83d\udccc `addpath` \ud328\ud0a4\uc9c0 README (Markdown \ud615\uc2dd, \ud55c\uae00 \ubc84\uc804)**  \n\ud83d\udce2 **\uc774 \ud328\ud0a4\uc9c0\ub294 Python\uc5d0\uc11c \uc0c1\uc704 \ub514\ub809\ud1a0\ub9ac\ub97c \uc790\ub3d9\uc73c\ub85c `sys.path`\uc5d0 \ucd94\uac00\ud558\uc5ec, \ubd88\ud544\uc694\ud55c `sys.path.insert()` \ud638\ucd9c\uc744 \uc904\uc774\ub294 \uac83\uc744 \ubaa9\ud45c\ub85c \ud569\ub2c8\ub2e4.**  \n\n```markdown\n# \ud83d\udccc addpath - Python\uc5d0\uc11c \uc790\ub3d9\uc73c\ub85c \uc0c1\uc704 \ub514\ub809\ud1a0\ub9ac\ub97c \ucd94\uac00\ud558\ub294 \ud328\ud0a4\uc9c0\n\n## \ud83d\ude80 \uc18c\uac1c\n`addpath`\ub294 Python\uc5d0\uc11c **\uc0c1\uc704 \ub514\ub809\ud1a0\ub9ac\ub97c \uc790\ub3d9\uc73c\ub85c `sys.path`\uc5d0 \ucd94\uac00**\ud558\ub294 \uc720\ud2f8\ub9ac\ud2f0 \ud328\ud0a4\uc9c0\uc785\ub2c8\ub2e4.  \n\ub354 \uc774\uc0c1 `sys.path.insert(0, \"..\")` \uac19\uc740 \ucf54\ub4dc\ub97c \ubc18\ubcf5\ud574\uc11c \uc791\uc131\ud560 \ud544\uc694\uac00 \uc5c6\uc2b5\ub2c8\ub2e4!\n\n## \ud83d\udccc \uc124\uce58 \ubc29\ubc95\nPyPI\uc5d0\uc11c \ubc14\ub85c \uc124\uce58\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.\n\n```sh\npip install addpath\n```\n\n\ub610\ub294 GitHub\uc5d0\uc11c \uc9c1\uc811 \uc124\uce58\ud560 \uc218\ub3c4 \uc788\uc2b5\ub2c8\ub2e4.\n\n```sh\npip install git+https://github.com/noggong/addpath.git\n```\n\n---\n\n## \ud83d\ude80 \uc0ac\uc6a9\ubc95\n### **1\ufe0f\u20e3 \uae30\ubcf8 \uc0ac\uc6a9\ubc95**\n```python\nimport addpath\n\n# \ud604\uc7ac \uc2a4\ud06c\ub9bd\ud2b8\uc758 \uc0c1\uc704 \ub514\ub809\ud1a0\ub9ac\ub97c sys.path\uc5d0 \ucd94\uac00\naddpath.add_parent_path()\n```\n\u2705 **\uc774\uc81c \uc0c1\uc704 \ub514\ub809\ud1a0\ub9ac\uc5d0 \uc788\ub294 \ubaa8\ub4c8\uc744 \ubc14\ub85c import\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4!**\n\n### **2\ufe0f\u20e3 \ud2b9\uc815 \ub808\ubca8\uc758 \uc0c1\uc704 \ub514\ub809\ud1a0\ub9ac \ucd94\uac00**\n\uae30\ubcf8\uc801\uc73c\ub85c `add_parent_path()` \ud568\uc218\ub294 **\ud604\uc7ac \uc2e4\ud589 \uc911\uc778 \ud30c\uc77c\uc758 1\ub2e8\uacc4 \uc0c1\uc704 \ub514\ub809\ud1a0\ub9ac\ub97c `sys.path`\uc5d0 \ucd94\uac00**\ud569\ub2c8\ub2e4.  \n\uadf8\ub7ec\ub098, \ub354 \uc0c1\uc704 \ub514\ub809\ud1a0\ub9ac\ub97c \ucd94\uac00\ud558\uace0 \uc2f6\ub2e4\uba74 `levels` \uac12\uc744 \uc870\uc815\ud558\uba74 \ub429\ub2c8\ub2e4.\n\n```python\n# \uc0c1\uc704 \ub514\ub809\ud1a0\ub9ac 2\ub2e8\uacc4 \ucd94\uac00\naddpath.add_parent_path(levels=2)\n```\n\u2705 **\uc774\uc81c \ub450 \ub2e8\uacc4 \uc704\uc5d0 \uc788\ub294 \ud328\ud0a4\uc9c0\ub3c4 `import`\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.**\n\n---\n\n## \ud83d\udccc \uc608\uc81c \ud504\ub85c\uc81d\ud2b8 \uad6c\uc870\n```sh\nmy_project/\n\u2502\u2500\u2500 main.py\n\u2502\u2500\u2500 src/\n\u2502   \u2502\u2500\u2500 my_module.py\n```\n\n\ud83d\udccc **\uc608\uc81c \ucf54\ub4dc (`src/my_module.py`)**\n```python\ndef hello():\n    return \"\uc548\ub155\ud558\uc138\uc694! addpath\ub97c \uc0ac\uc6a9\ud558\uba74 \ud3b8\ub9ac\ud574\uc694.\"\n```\n\n\ud83d\udccc **main.py\uc5d0\uc11c `my_module.py`\ub97c import\ud558\ub294 \ubc29\ubc95**\n```python\nimport addpath\naddpath.add_parent_path()\n\nimport my_module\nprint(my_module.hello())  # \"\uc548\ub155\ud558\uc138\uc694! addpath\ub97c \uc0ac\uc6a9\ud558\uba74 \ud3b8\ub9ac\ud574\uc694.\"\n```\n\n\u2705 **\ub354 \uc774\uc0c1 `sys.path.insert()`\ub97c \ubc18\ubcf5\ud574\uc11c \ucd94\uac00\ud560 \ud544\uc694\uac00 \uc5c6\uc2b5\ub2c8\ub2e4!**\n\n---\n\n## \ud83d\udccc \uc790\ub3d9\uc73c\ub85c `sys.path`\ub97c \uc124\uc815\ud574\uc57c \ud558\ub294 \uacbd\uc6b0\n- **\ud504\ub85c\uc81d\ud2b8 \uad6c\uc870\uac00 \ubcf5\uc7a1\ud55c \uacbd\uc6b0**\n- **\ud14c\uc2a4\ud2b8 \ucf54\ub4dc\uc5d0\uc11c \ubd80\ubaa8 \ub514\ub809\ud1a0\ub9ac\uc758 \ubaa8\ub4c8\uc744 \ubd88\ub7ec\uc640\uc57c \ud560 \ub54c**\n- **Jupyter Notebook\uc5d0\uc11c \uc678\ubd80 \ubaa8\ub4c8\uc744 \uc27d\uac8c \ubd88\ub7ec\uc624\uace0 \uc2f6\uc744 \ub54c**\n- **Python \uc2a4\ud06c\ub9bd\ud2b8 \uc2e4\ud589 \uc2dc \ubd88\ud544\uc694\ud55c `sys.path.append()` \ucf54\ub4dc \uc5c6\uc774 \uc2e4\ud589\ud558\uace0 \uc2f6\uc744 \ub54c**\n\n---\n\n## \ud83d\ude80 \uae30\ub2a5 \uc815\ub9ac\n\u2714 `add_parent_path(levels=1)` \u2192 \ud604\uc7ac \ub514\ub809\ud1a0\ub9ac\uc758 `levels`\ub9cc\ud07c \uc0c1\uc704 \ub514\ub809\ud1a0\ub9ac\ub97c `sys.path`\uc5d0 \ucd94\uac00  \n\u2714 `pip install addpath` \u2192 \uc5b4\ub514\uc11c\ub4e0 \uac04\ud3b8\ud558\uac8c \uc124\uce58 \ud6c4 \uc0ac\uc6a9 \uac00\ub2a5  \n\u2714 Python 3.6 \uc774\uc0c1 \uc9c0\uc6d0 \ud83d\ude80  \n\n---\n\n## \ud83d\udccc \ub77c\uc774\uc120\uc2a4\n\uc774 \ud504\ub85c\uc81d\ud2b8\ub294 **MIT \ub77c\uc774\uc120\uc2a4**\ub85c \uc81c\uacf5\ub429\ub2c8\ub2e4. \uc790\uc720\ub86d\uac8c \uc0ac\uc6a9 \ubc0f \uc218\uc815\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.  \n\n---\n\n## \ud83d\udccc \uae30\uc5ec \ubc29\ubc95\n`addpath` \ud504\ub85c\uc81d\ud2b8\uc5d0 \uae30\uc5ec\ud558\uace0 \uc2f6\ub2e4\uba74, GitHub\uc5d0\uc11c Fork \ud6c4 PR\uc744 \ubcf4\ub0b4\uc8fc\uc138\uc694! \ud83d\ude80  \n```sh\ngit clone https://github.com/yourusername/addpath.git\ncd addpath\npip install -e .\n```\n\n\u2705 **\uc774\uc81c \uac1c\ubc1c \ud658\uacbd\uc5d0\uc11c `addpath`\ub97c \ud14c\uc2a4\ud2b8\ud558\uace0 \uac1c\uc120\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.** \ud83d\ude80\ud83d\udd25  \n\n---\n\n\ud83d\udccc **\uc774\uc81c Python \ud504\ub85c\uc81d\ud2b8\uc5d0\uc11c `sys.path` \ubb38\uc81c\ub97c \uac04\ub2e8\ud558\uac8c \ud574\uacb0\ud558\uc138\uc694!** \ud83d\ude80\n```\n\n\u2705 **Markdown \ubb38\ubc95\uc774 \uc801\uc6a9\ub41c README\ub85c, \ubc14\ub85c GitHub\uc774\ub098 PyPI\uc5d0\uc11c \uc0ac\uc6a9 \uac00\ub2a5\ud569\ub2c8\ub2e4!** \ud83d\ude80\ud83d\udd25\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Automatically add parent directories to sys.path in Python",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/noggong/addpath"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a53d37b8447a816eacfcb821642268ab91bfb1b6d33a3d3c9ac5ff1effb2d093",
                "md5": "2d956aff603218181d274c8d62e57928",
                "sha256": "a607d507a007f5d73bf04b7f74fb95a29a932bd42385d702f2703fc050edd484"
            },
            "downloads": -1,
            "filename": "addpath-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2d956aff603218181d274c8d62e57928",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 3284,
            "upload_time": "2025-02-11T02:45:51",
            "upload_time_iso_8601": "2025-02-11T02:45:51.481496Z",
            "url": "https://files.pythonhosted.org/packages/a5/3d/37b8447a816eacfcb821642268ab91bfb1b6d33a3d3c9ac5ff1effb2d093/addpath-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2413a569d31d0cf122a1beaa6a10419dab7cbf3d9e9aa6ab77b9230884216aba",
                "md5": "8d5141cc48b837ab402ffe5449f82e6c",
                "sha256": "83d3b4312a330c80d59b40cad5aaef6930a51b899bd54d71d9b8f8c56a150b38"
            },
            "downloads": -1,
            "filename": "addpath-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "8d5141cc48b837ab402ffe5449f82e6c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 2928,
            "upload_time": "2025-02-11T02:45:53",
            "upload_time_iso_8601": "2025-02-11T02:45:53.594759Z",
            "url": "https://files.pythonhosted.org/packages/24/13/a569d31d0cf122a1beaa6a10419dab7cbf3d9e9aa6ab77b9230884216aba/addpath-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-11 02:45:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "noggong",
    "github_project": "addpath",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "addpath"
}