# Autogen Init: Simplify Package Setup
Autogen-Init is a Python tool designed to make `__init__.py` file updates seamless across your package, ensuring imports are clean and easy to access. It scans your package's directories to automatically update `__init__.py` files with all necessary class and function imports. Plus, it simplifies adding version and author details to your top-level `__init__.py`, boosting package metadata.
## Features
- **Auto Updates**: Instantly refreshes `__init__.py` files with internal imports.
- **Metadata Enhancements**: Adds version and author info effortlessly.
- **Flexible Overwrites**: Choose to update or append `__init__.py` files as needed.
## 📦 Installation
Get Autogen-Init with pip for a smooth integration:
```
pip install autogen-init
```
## Usage
Activate Autogen-Init with the `run` command, setting your package's root as the start path. Opt to overwrite `__init__.py` files and add version and author data.
```python
from autoinit import run
# Quick start
run(
start_path='C:/path/to/my_package',
overwrite=True,
version="1.0.0",
author="Minwoo(Daniel) Park <parkminwoo1991@gmail.com>"
)
```
Argument of run function:
- *start_path (str): Your package's root directory.*
- *overwrite (bool): Flag to overwrite `__init__.py` files, default is `True`.*
- *version (str): Package version for the top-level `__init__.py`.*
- *author (str): Package author(s) for the top-level `__init__.py`.*
## Contributing
Your contributions are welcome! For bug reports, feature suggestions, or submissions, don't hesitate to get in touch or open a pull request.
## ©️ License
Autogen-Init is MIT licensed — see the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsdanielpark/auto-init",
"name": "autogen-init",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Python,Python package init,package init,autoinit,package initialization,init.py automation",
"author": "Daniel Park",
"author_email": "parkminwoo1991@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/15/70/5d4bd78ac33bc41312b819575f9998ee815ff84c3bb006dd9cff66465dd3/autogen-init-2.0.4.tar.gz",
"platform": null,
"description": "# Autogen Init: Simplify Package Setup\r\n\r\nAutogen-Init is a Python tool designed to make `__init__.py` file updates seamless across your package, ensuring imports are clean and easy to access. It scans your package's directories to automatically update `__init__.py` files with all necessary class and function imports. Plus, it simplifies adding version and author details to your top-level `__init__.py`, boosting package metadata.\r\n\r\n## Features\r\n\r\n- **Auto Updates**: Instantly refreshes `__init__.py` files with internal imports.\r\n- **Metadata Enhancements**: Adds version and author info effortlessly.\r\n- **Flexible Overwrites**: Choose to update or append `__init__.py` files as needed.\r\n\r\n## \ud83d\udce6 Installation\r\n\r\nGet Autogen-Init with pip for a smooth integration:\r\n\r\n```\r\npip install autogen-init\r\n```\r\n\r\n## Usage\r\n\r\nActivate Autogen-Init with the `run` command, setting your package's root as the start path. Opt to overwrite `__init__.py` files and add version and author data.\r\n\r\n```python\r\nfrom autoinit import run\r\n\r\n# Quick start\r\nrun(\r\n start_path='C:/path/to/my_package',\r\n overwrite=True,\r\n version=\"1.0.0\",\r\n author=\"Minwoo(Daniel) Park <parkminwoo1991@gmail.com>\"\r\n)\r\n```\r\nArgument of run function:\r\n- *start_path (str): Your package's root directory.*\r\n- *overwrite (bool): Flag to overwrite `__init__.py` files, default is `True`.*\r\n- *version (str): Package version for the top-level `__init__.py`.*\r\n- *author (str): Package author(s) for the top-level `__init__.py`.*\r\n\r\n## Contributing\r\n\r\nYour contributions are welcome! For bug reports, feature suggestions, or submissions, don't hesitate to get in touch or open a pull request.\r\n\r\n## \u00a9\ufe0f License\r\n\r\nAutogen-Init is MIT licensed \u2014 see the LICENSE file for details.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python package that updates init.py files across a package for direct imports.",
"version": "2.0.4",
"project_urls": {
"Homepage": "https://github.com/dsdanielpark/auto-init"
},
"split_keywords": [
"python",
"python package init",
"package init",
"autoinit",
"package initialization",
"init.py automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2edacf0553b7955f514e9d28db63c4f03f295a510f9b30943c959f23ac2132a",
"md5": "81c143a30a2405ac4eccc59649ffdd85",
"sha256": "225676f5a0236b79580911e0b87e9a247ab2736d3e0e3829b53968ad070ea662"
},
"downloads": -1,
"filename": "autogen_init-2.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81c143a30a2405ac4eccc59649ffdd85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4628,
"upload_time": "2024-03-18T13:12:04",
"upload_time_iso_8601": "2024-03-18T13:12:04.572015Z",
"url": "https://files.pythonhosted.org/packages/a2/ed/acf0553b7955f514e9d28db63c4f03f295a510f9b30943c959f23ac2132a/autogen_init-2.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15705d4bd78ac33bc41312b819575f9998ee815ff84c3bb006dd9cff66465dd3",
"md5": "77f5c7cfaec3b15260b4c3e83f0bcb9e",
"sha256": "9ee67233a6b625081685a217bd028ff5e0b465237dcd528b170f87e6322eceaa"
},
"downloads": -1,
"filename": "autogen-init-2.0.4.tar.gz",
"has_sig": false,
"md5_digest": "77f5c7cfaec3b15260b4c3e83f0bcb9e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4242,
"upload_time": "2024-03-18T13:12:08",
"upload_time_iso_8601": "2024-03-18T13:12:08.174192Z",
"url": "https://files.pythonhosted.org/packages/15/70/5d4bd78ac33bc41312b819575f9998ee815ff84c3bb006dd9cff66465dd3/autogen-init-2.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 13:12:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsdanielpark",
"github_project": "auto-init",
"github_not_found": true,
"lcname": "autogen-init"
}
JSON
