Metadata-Version: 1.1
Name: versionary
Version: 0.3
Summary: Code versioning decorator
Home-page: https://github.com/wearespindle/versionary
Author: Devhouse Spindle
Author-email: opensource@wearespindle.com
License: MIT License
Description: Versionary
        ==========
        
        |Build Status|
        
        Package that allows to version code paths with the use of a decorator.
        
        Status
        ------
        
        Currently actively used and watched.
        
        Usage
        -----
        
        Requirements
        ~~~~~~~~~~~~
        
        -  python 2.7
        -  python 3.3, 3.4, 3.5
        
        Installation
        ~~~~~~~~~~~~
        
        ::
        
            pip install versionary
        
        Running
        ~~~~~~~
        
        Usage 1.
        
        .. code:: python
        
        
            from versionary.decorators import versioned
        
            @versioned()
            def my_func():
                return 1
        
            @versioned()
            def my_func__v2:
                return 2
        
            one = my_func.v1()
            two = my_func.v2()
        
        Usage 2.
        
        .. code:: python
        
            @versioned(1)
            def my_func():
                return 1
        
            @versioned(2)
            def my_func:
                return 2
        
            one = my_func.v1()
            two = my_func.v2()
        
        You can use the validate\_module function from versionary.utils to
        validate correct use of the decorator in the given module.
        
        Contributing
        ------------
        
        See the
        `CONTRIBUTING.md <https://github.com/wearespindle/versionary/blob/develop/CONTRIBUTING.md>`__
        file on how to contribute to this project.
        
        Contributors
        ------------
        
        See the
        `CONTRIBUTORS.md <https://github.com/wearespindle/versionary/blob/develop/CONTRIBUTORS.md>`__
        file for a list of contributors to the project.
        
        Roadmap
        -------
        
        Changelog
        ~~~~~~~~~
        
        The changelog can be found in the
        `CHANGELOG.md <https://github.com/wearespindle/versionary/blob/develop/CHANGELOG.md>`__
        file.
        
        In progress
        ~~~~~~~~~~~
        
        -  Minor improvements
        
        Future
        ~~~~~~
        
        -  Scoped versioning (Class methods)
        
        Get in touch with a developer
        -----------------------------
        
        If you want to report an issue see the
        `CONTRIBUTING.md <https://github.com/wearespindle/versionary/blob/develop/CONTRIBUTING.md>`__
        file for more info.
        
        We will be happy to answer your other questions at
        opensource@wearespindle.com
        
        .. |Build Status| image:: https://travis-ci.org/wearespindle/versionary.svg?branch=develop
           :target: https://travis-ci.org/wearespindle/versionary
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Version Control
