Metadata-Version: 2.4
Name: yamlpack
Version: 0.3.0
Summary: Package boilerplate creator using YAML schemas
Home-page: https://github.com/clntsf/yamlpack
Author: Colin Simon-Fellowes
Author-email: colin.tsf@gmail.com
Project-URL: Repo, https://github.com/clntsf/yamlpack
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.12.2
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyyaml>=6.0.0
Requires-Dist: platformdirs>=4.3.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# yamlpack
Package boilerplate creator using YAML schemas

## Sample Schema:

Users can generate a package using simple, quickly-written
YAML schemas as below: 
Properties are given for name and description, and the module
structure is written in a simple syntax

```yaml
# package name and description for setup.py
name: my-package
description: my very first package!

# here we list a filestructure-like module structure,
# where an item is a string if it has no children
# and an object if it has children. The toplevel is
# always "modules"
modules:
  - module_one
  - module_two:
      - submodule_one
  - module_three
```

## TODOs:

[ ] *(Compat)*: Ensure filesystem operations work cross-platform and migrate them if not.

[ ] *(CLI)*: Map out and implement a set of actions/subparsers

[ ] *(CLI)*: Implement CLI for main and alt flows

[ ] *(Builders)*: Decide on a builder protocol, populate the sample repo and link it

[x] *(Config)*: Refactor config get and update functions to ensure write destination is in user data folder

## Milestones:

31 July 2025: 0.1.0 is the first version uploaded to [PyPI](https://pypi.org/project/yamlpack/) :partying_face:
