Skip to main content

A YAML-format configuration generator

Project description

Ycleptic

YAML configuration generator

YAML is a popular markup language for input files, with its easy syntax and clear mapping to lists and dicts. Ycleptic allows a developer to specify all keys, datatypes, default values, choice restrictions, and other features of YAML-format input files for use in their own apps. This makes the specification of input file syntax on top of YAML for any particular application a bit easier than just using pure YAML. In addition, ycleptic can also automatically build the RST/Sphinx doctree for your app's configuration file.

Installation

pip install ycleptic

Once installed, the developer has access to the Yclept class.

Release History

  • 1.0.9
    • bugfix: shows default values for any dict-type parameters
    • bugfix: choices in interactive help did not work with integer choices
  • 1.0.7
    • bugfix: bad string in doc builder
  • 1.0.6
    • interactive mode implemented
    • config-help subcommand added
    • make-doc subcommand added
  • 1.0.5
    • added support for a user dotfile/rcfile
  • 1.0.4
    • added **kwargs to console_help to allow override of print
  • 1.0.3.3
    • fixed spurious output
  • 1.0.3.2
    • fixed version detection bug
  • 1.0.2
    • Updated documentation; added version detection
  • 1.0.1
    • Include example base config
  • 1.0.0
    • Initial version

Meta

Cameron F. Abrams – cfa22@drexel.edu

Distributed under the MIT license. See LICENSE for more information.

https://github.com/cameronabrams

https://github.com/AbramsGroup

Contributing

  1. Fork it (https://github.com/AbramsGroup/HTPolyNet/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ycleptic-1.0.9.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ycleptic-1.0.9-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file ycleptic-1.0.9.tar.gz.

File metadata

  • Download URL: ycleptic-1.0.9.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.2

File hashes

Hashes for ycleptic-1.0.9.tar.gz
Algorithm Hash digest
SHA256 d58b2fa4034d55a25a1cd6b929a71c56ae8fe38ce5717be9417b5c8c59901c22
MD5 c6dce277e7e5947e0d6fdf7385ca7de5
BLAKE2b-256 3fccbcf7999d3d60b356948bf55536c5f2eca8720cfa49377a9eebf73d7ed0ea

See more details on using hashes here.

File details

Details for the file ycleptic-1.0.9-py3-none-any.whl.

File metadata

  • Download URL: ycleptic-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.2

File hashes

Hashes for ycleptic-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 ca9478a26dc4c04b072d222389a234225f63df695ac1cff6c924aa8ae62f8145
MD5 852bbc0ad2aeb143818b829a41d38613
BLAKE2b-256 8bd0c033fb8b403318d153c186ed966461ad01771bcbf6ef9e055e803c5e9c6f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page