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.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.3.0.tar.gz (18.5 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.3.0-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ycleptic-1.3.0.tar.gz
Algorithm Hash digest
SHA256 be728e5e4a7ffa8f8ef0b2f62105807e997da569e1acfb4c6ce96c4de9cb400d
MD5 07d63c35ef68d250028c25df7b723e6d
BLAKE2b-256 01acbb50aa46ace2f8709c24334fcf9a84d00fb10bbf48f637e947faba98be8e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ycleptic-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eb88155c774aa1a66614b105d5bd96a4ec7eec199d384ba289b8be78d8e96552
MD5 1e4bd3ba1d343118348233e71697c192
BLAKE2b-256 2b21a7ecaffe8a317632e3c28276daf18624ae4a5d45b3c8a21c78257b6be570

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