# scaffold-kit
[](https://pypi.org/project/scaffold-kit/)
[](https://pypi.org/project/scaffold-kit/)
[](https://github.com/sidisinsane/scaffold-kit/blob/main/LICENSE)
A comprehensive toolkit for project initialization and structure management.
Create projects from structured data definitions, generate file checklists for
tracking progress, and visualize directory hierarchies with ASCII trees.
## Installation
Install from PyPI:
```bash
pip install scaffold-kit
```
Install with uv:
```bash
uv add scaffold-kit
```
Install development releases from TestPyPI:
```bash
pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ scaffold-kit
```
Install development releases from TestPyPI with uv:
```bash
uv add --index https://test.pypi.org/simple/ --index https://pypi.org/simple/ scaffold-kit
```
## Usage
scaffold-kit provides four main commands for project management:
**Initialize a project with example files:**
```bash
scaffold-kit init [ignore-file|config-file|scaffold-file]
```
**Create project structure from YAML/JSON definition:**
```bash
scaffold-kit scaffold [--root]
```
**Generate a file checklist for progress tracking:**
```bash
scaffold-kit checklist
```
**Create an ASCII tree of directory structure:**
```bash
scaffold-kit tree [directory] [--ignore-file FILE]
```
## Links
- **[Repository][1]** - Main GitHub repository
- **[Package][2]** - PyPI package page
- **[Test Package][3]** - TestPyPI package page for development releases
- **[Getting Started][4]** - This README with basic usage and examples
- **[Full Documentation][5]** - Complete guides, tutorials, and examples
- **[API Reference][6]** - Detailed API documentation and code reference
- **[Issues & Bug Reports][7]** - Report bugs or request features
## Acknowledgments
- [uv][8] - Fast Python package installer and resolver
- [asdf][9] - Multi-language version manager
- [Semantic Release][10] - Automated versioning
- [Pre-commit][11] - Git hooks for code quality
- [MkDocs][12] - Documentation generator
- [Sphinx][13] - API documentation generator
[1]: https://github.com/sidisinsane/scaffold-kit
[2]: https://pypi.org/project/scaffold-kit/
[3]: https://test.pypi.org/project/scaffold-kit/
[4]: https://github.com/sidisinsane/scaffold-kit#readme
[5]: https://sidisinsane.github.io/scaffold-kit/
[6]: https://sidisinsane.github.io/scaffold-kit/reference/
[7]: https://github.com/sidisinsane/scaffold-kit/issues
[8]: https://docs.astral.sh/uv/
[9]: https://asdf-vm.com/
[10]: https://python-semantic-release.readthedocs.io/
[11]: https://pre-commit.com/
[12]: https://www.mkdocs.org/
[13]: https://www.sphinx-doc.org/
Raw data
{
"_id": null,
"home_page": null,
"name": "scaffold-kit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "cli, cli-tool, command-line, command-line-tool, directory-tree, file-tree, generator, productivity, project-structure, scaffold, tree",
"author": null,
"author_email": "Dirk Sidney Jansen <sidisinsane@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/08/33/6e73539473b0f69b51f63d6ac3bf4ce33896100d6ee2fe86e2a9ca5e2343/scaffold_kit-1.0.1.tar.gz",
"platform": null,
"description": "# scaffold-kit\n\n[](https://pypi.org/project/scaffold-kit/)\n[](https://pypi.org/project/scaffold-kit/)\n[](https://github.com/sidisinsane/scaffold-kit/blob/main/LICENSE)\n\nA comprehensive toolkit for project initialization and structure management.\nCreate projects from structured data definitions, generate file checklists for\ntracking progress, and visualize directory hierarchies with ASCII trees.\n\n## Installation\n\nInstall from PyPI:\n\n```bash\npip install scaffold-kit\n```\n\nInstall with uv:\n\n```bash\nuv add scaffold-kit\n```\n\nInstall development releases from TestPyPI:\n\n```bash\npip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ scaffold-kit\n```\n\nInstall development releases from TestPyPI with uv:\n\n```bash\nuv add --index https://test.pypi.org/simple/ --index https://pypi.org/simple/ scaffold-kit\n```\n\n## Usage\n\nscaffold-kit provides four main commands for project management:\n\n**Initialize a project with example files:**\n\n```bash\nscaffold-kit init [ignore-file|config-file|scaffold-file]\n```\n\n**Create project structure from YAML/JSON definition:**\n\n```bash\nscaffold-kit scaffold [--root]\n```\n\n**Generate a file checklist for progress tracking:**\n\n```bash\nscaffold-kit checklist\n```\n\n**Create an ASCII tree of directory structure:**\n\n```bash\nscaffold-kit tree [directory] [--ignore-file FILE]\n```\n\n## Links\n\n- **[Repository][1]** - Main GitHub repository\n- **[Package][2]** - PyPI package page\n- **[Test Package][3]** - TestPyPI package page for development releases\n- **[Getting Started][4]** - This README with basic usage and examples\n- **[Full Documentation][5]** - Complete guides, tutorials, and examples\n- **[API Reference][6]** - Detailed API documentation and code reference\n- **[Issues & Bug Reports][7]** - Report bugs or request features\n\n## Acknowledgments\n\n- [uv][8] - Fast Python package installer and resolver\n- [asdf][9] - Multi-language version manager\n- [Semantic Release][10] - Automated versioning\n- [Pre-commit][11] - Git hooks for code quality\n- [MkDocs][12] - Documentation generator\n- [Sphinx][13] - API documentation generator\n\n[1]: https://github.com/sidisinsane/scaffold-kit\n[2]: https://pypi.org/project/scaffold-kit/\n[3]: https://test.pypi.org/project/scaffold-kit/\n[4]: https://github.com/sidisinsane/scaffold-kit#readme\n[5]: https://sidisinsane.github.io/scaffold-kit/\n[6]: https://sidisinsane.github.io/scaffold-kit/reference/\n[7]: https://github.com/sidisinsane/scaffold-kit/issues\n[8]: https://docs.astral.sh/uv/\n[9]: https://asdf-vm.com/\n[10]: https://python-semantic-release.readthedocs.io/\n[11]: https://pre-commit.com/\n[12]: https://www.mkdocs.org/\n[13]: https://www.sphinx-doc.org/\n",
"bugtrack_url": null,
"license": null,
"summary": "Command-line tools for project setup, structure creation, file tracking, and directory trees.",
"version": "1.0.1",
"project_urls": {
"API Reference": "https://sidisinsane.github.io/scaffold-kit/reference/",
"Bug Tracker": "https://github.com/sidisinsane/scaffold-kit/issues",
"Documentation": "https://sidisinsane.github.io/scaffold-kit/",
"Homepage": "https://github.com/sidisinsane/scaffold-kit",
"Repository": "https://github.com/sidisinsane/scaffold-kit.git"
},
"split_keywords": [
"cli",
" cli-tool",
" command-line",
" command-line-tool",
" directory-tree",
" file-tree",
" generator",
" productivity",
" project-structure",
" scaffold",
" tree"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "aefd45721dad86f4ce3406e8b10fd65469a51ee50b9a64aa05f0ccadd6d23e1d",
"md5": "4dd139fb1d30bf7ea01e1664c43ea5ae",
"sha256": "7c1182089aceb74d9e25da757f261848d17d1449a144284fbf8f18a49f58ff05"
},
"downloads": -1,
"filename": "scaffold_kit-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4dd139fb1d30bf7ea01e1664c43ea5ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 32977,
"upload_time": "2025-08-30T06:29:10",
"upload_time_iso_8601": "2025-08-30T06:29:10.729333Z",
"url": "https://files.pythonhosted.org/packages/ae/fd/45721dad86f4ce3406e8b10fd65469a51ee50b9a64aa05f0ccadd6d23e1d/scaffold_kit-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "08336e73539473b0f69b51f63d6ac3bf4ce33896100d6ee2fe86e2a9ca5e2343",
"md5": "5065fdc77946fb10c0285c0bb9f010bb",
"sha256": "fa83cfb7f15230a1b00f78585dc99cb0650450e0b173a315454de2f3c067a22e"
},
"downloads": -1,
"filename": "scaffold_kit-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5065fdc77946fb10c0285c0bb9f010bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 52316,
"upload_time": "2025-08-30T06:29:12",
"upload_time_iso_8601": "2025-08-30T06:29:12.215677Z",
"url": "https://files.pythonhosted.org/packages/08/33/6e73539473b0f69b51f63d6ac3bf4ce33896100d6ee2fe86e2a9ca5e2343/scaffold_kit-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-30 06:29:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sidisinsane",
"github_project": "scaffold-kit",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "scaffold-kit"
}
JSON
