Certifiable

Certifiable is a powerful runtime parameter validation library for python, see: Usage.

Use it in in conjunction with HOFT to automatically validate method args and kwargs.

Example:

>>> from certifiable import certify_bool
>>> certify_bool(True)
>>> certify_bool(False)
>>> certify_bool('hello world')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "certifiable/certifiable.py", line 63, in wrapper
    certify(value)
  File "certifiable/certifiable.py", line 60, in certify
    func(value, **kwargs)
  File "certifiable/certifiable.py", line 512, in certify_bool
    required=required,
certifiable.errors.CertifierTypeError: expected bool, but value is of type 'str'
>>>

Contents:

Certifiable

Certifiable is a powerful runtime parameter validation library for python.

Features

Examples of all features can be found here: Usage.

It can validate the following basic types:

• Text
• Unicode
• String
• Bytes
• Bool
• Int
• Long
• Number
• Decimal
• Float
• Enum
• Timestamp
• Date
• Object

And also these more complex or compound types into which you can pass other certifiers:

• List
• Tuple
• Set
• Iterable
• Dict
• Json
• Html
• Email

There are logical operators to combine certifiers:

• ANY (certify_only_one)
• AND (certify_all)
• ALL (certify_all)
• NAND (certify_none)
• XOR (certify_only_one)

Status

ALPHA

• Free software: MIT license
• Documentation: https://certifiable.readthedocs.io.

Installation

Stable release

To install certifiable, run this command in your terminal:

$ pip install certifiable

This is the preferred method to install certifiable, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for certifiable can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/sys-git/certifiable

Or download the tarball:

$ curl  -OL https://github.com/sys-git/certifiable/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

Coming soon:

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/sys-git/certifiable/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

certifiable could always use more documentation, whether as part of the official certifiable docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/sys-git/certifiable/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up certifiable for local development.

1. Fork the certifiable repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/certifiable.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv certifiable
   $ cd certifiable/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 certifiable tests
   $ python setup.py test or py.test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/sys-git/certifiable/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_certifiable

Credits

Development Lead

• Francis Horsman <francis.horsman@gmail.com>

Contributors

None yet. Why not be the first?

History

Indices and tables

• Index
• Module Index
• Search Page