Metadata-Version: 2.4
Name: scaffold-kit
Version: 1.0.1
Summary: Command-line tools for project setup, structure creation, file tracking, and directory trees.
Project-URL: Homepage, https://github.com/sidisinsane/scaffold-kit
Project-URL: Documentation, https://sidisinsane.github.io/scaffold-kit/
Project-URL: API Reference, https://sidisinsane.github.io/scaffold-kit/reference/
Project-URL: Repository, https://github.com/sidisinsane/scaffold-kit.git
Project-URL: Bug Tracker, https://github.com/sidisinsane/scaffold-kit/issues
Author-email: Dirk Sidney Jansen <sidisinsane@users.noreply.github.com>
License-Expression: MIT
License-File: LICENSE
Keywords: cli,cli-tool,command-line,command-line-tool,directory-tree,file-tree,generator,productivity,project-structure,scaffold,tree
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: System :: Filesystems
Classifier: Topic :: Utilities
Requires-Python: >=3.12
Requires-Dist: pyyaml~=6.0.2
Provides-Extra: build
Requires-Dist: python-semantic-release~=10.3.1; extra == 'build'
Provides-Extra: dev
Requires-Dist: bandit~=1.8.6; extra == 'dev'
Requires-Dist: coverage~=7.10.1; extra == 'dev'
Requires-Dist: mypy~=1.17.0; extra == 'dev'
Requires-Dist: pre-commit~=4.3.0; extra == 'dev'
Requires-Dist: pylint~=3.3.8; extra == 'dev'
Requires-Dist: pytest-cov~=6.2.1; extra == 'dev'
Requires-Dist: pytest~=8.4.1; extra == 'dev'
Requires-Dist: ruff~=0.12.10; extra == 'dev'
Requires-Dist: taplo~=0.9.3; extra == 'dev'
Requires-Dist: yamllint~=1.37.1; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-gen-files~=0.5.0; extra == 'docs'
Requires-Dist: mkdocs-material~=9.6.16; extra == 'docs'
Requires-Dist: mkdocs-nav-weight~=0.2.0; extra == 'docs'
Requires-Dist: mkdocs-section-index~=0.3.10; extra == 'docs'
Requires-Dist: mkdocstrings[python]~=0.30.0; extra == 'docs'
Requires-Dist: mkdocs~=1.6.1; extra == 'docs'
Requires-Dist: pymdown-extensions~=10.16.1; extra == 'docs'
Requires-Dist: sphinx-favicon~=1.0.1; extra == 'docs'
Requires-Dist: sphinx~=8.2.3; extra == 'docs'
Provides-Extra: test
Requires-Dist: coverage~=7.10.1; extra == 'test'
Requires-Dist: pytest-cov~=6.2.1; extra == 'test'
Requires-Dist: pytest~=8.4.1; extra == 'test'
Description-Content-Type: text/markdown

# scaffold-kit

[![PyPI - Version](https://img.shields.io/pypi/v/scaffold-kit)](https://pypi.org/project/scaffold-kit/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/scaffold-kit)](https://pypi.org/project/scaffold-kit/)
[![GitHub License](https://img.shields.io/github/license/sidisinsane/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/
