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.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.2.0.tar.gz (18.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.2.0-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ycleptic-1.2.0.tar.gz
Algorithm Hash digest
SHA256 03c22abd6a943bacbd6b8238e65235e5bd8ac3f92bba3cd3a5cc678d9ff4d5d5
MD5 934baf039532d5eeab0d153b17a1f90e
BLAKE2b-256 736b571bed4ecc5aae21252a47abf1f444354c427dbfefaa24ad08a771b95f31

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ycleptic-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 775663e8bcb5707f8553ff8f00f4c9b2bc17bf8f526222a3cc1dce52aa5fbb22
MD5 874e2bb9bcabae3b94f4af7c54fec045
BLAKE2b-256 4329a28f0a24b87966d5fc2637ac9a65ef40b55ef9e00f63cf499d439ac1fed9

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