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.9.0
    • new update_user method
  • 1.8.1
    • fixed faulty special update of dict-like values with defaults
  • 1.8.0
    • more informative error messages via raise_clean
  • 1.7.0
    • Restructured code-base and expanded documentation
  • 1.6.2
    • footer-style argument added to make-docs
  • 1.5.0
    • example subfield in docs directive enabled
  • 1.4.1
    • case_sensitive boolean attribute enabled for all str-types
  • 1.3.0
    • __init__ optionally accepts a dict instead of only a file name
  • 1.2.0
    • make-doc subcommand upgraded to put RST links at the top of every RST file
  • 1.1.0
    • 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.9.0.tar.gz (25.3 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.9.0-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ycleptic-1.9.0.tar.gz
  • Upload date:
  • Size: 25.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for ycleptic-1.9.0.tar.gz
Algorithm Hash digest
SHA256 250f5484637f702bb4efc0f65a25f73d2574b981e84e98f2d118f2c68b752dd4
MD5 8e306c32e8bb615b6ca5bbb6b9ddb1db
BLAKE2b-256 ad0c5eddb63f58be1e0bdd23a0faee3aa9d8ed319ab28d32fb35300a89859e6c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ycleptic-1.9.0-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for ycleptic-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e7a0ae4a449e484bd294d1c21d9b169a11d52de211c90460bf3805ed0af2887
MD5 6c409439f80a7d4e6122233f95479638
BLAKE2b-256 98dcf4811387cbbbd0b1721dacc613e3f354c69945ad0b02ec1a3dc40eddd956

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