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.6.1
    • 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.6.1.tar.gz (22.4 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.6.1-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ycleptic-1.6.1.tar.gz
Algorithm Hash digest
SHA256 b96037b972b0e1eaccdab2cc85f9f4c00c75be2c40dae327036198253a2847c7
MD5 c14b33f9139c2799dc84a8dfc6d23750
BLAKE2b-256 5ef906a17a3cd921e3de0e1f627dab99cf2892e45804c591552c23ef654b3c5b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ycleptic-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 63bcfb3c5b308199bd6763fbb4e642c01bba52b7b979b00e8401bc5b9266bff6
MD5 2ae8090c3291b529c8f379a22aa05a88
BLAKE2b-256 cdb55e42a6d5c99a97fa0178f9e55f26d9e7bbceb285a1b2e2c4d6d09be3ee85

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