Metadata-Version: 1.1
Name: candyshop
Version: 0.1.3
Summary: Candyshop is a helper to determine if all your dependencies are declared properly.
Home-page: https://github.com/LuisAlejandro/candyshop
Author: Luis Alejandro Martínez Faneyth
Author-email: luis@huntingbears.com.ve
License: 
Copyright (C) 2016-2017, Candyshop Developers.

Please refer to AUTHORS.rst for a complete list of Copyright holders.

Candyshop is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Candyshop is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see http://www.gnu.org/licenses.

Description: .. image:: https://gitcdn.xyz/repo/LuisAlejandro/candyshop/master/docs/_static/banner.svg
        
        ..
        
            An assistant to determine if all your dependencies are declared properly in your odoo module.
        
        .. image:: https://img.shields.io/pypi/v/candyshop.svg
           :target: https://pypi.python.org/pypi/candyshop
           :alt: PyPI Package
        
        .. image:: https://img.shields.io/travis/LuisAlejandro/candyshop.svg
           :target: https://travis-ci.org/LuisAlejandro/candyshop
           :alt: Travis CI
        
        .. image:: https://coveralls.io/repos/github/LuisAlejandro/candyshop/badge.svg?branch=master
           :target: https://coveralls.io/github/LuisAlejandro/candyshop?branch=master
           :alt: Coveralls
        
        .. image:: https://codeclimate.com/github/LuisAlejandro/candyshop/badges/gpa.svg
           :target: https://codeclimate.com/github/LuisAlejandro/candyshop
           :alt: Code Climate
        
        .. image:: https://pyup.io/repos/github/LuisAlejandro/candyshop/shield.svg
           :target: https://pyup.io/repos/github/LuisAlejandro/candyshop/
           :alt: Updates
        
        .. image:: https://readthedocs.org/projects/candyshop/badge/?version=latest
           :target: https://readthedocs.org/projects/candyshop/?badge=latest
           :alt: Read The Docs
        
        .. image:: https://cla-assistant.io/readme/badge/LuisAlejandro/candyshop
           :target: https://cla-assistant.io/LuisAlejandro/candyshop
           :alt: Contributor License Agreement
        
        .. image:: https://badges.gitter.im/LuisAlejandro/candyshop.svg
           :target: https://gitter.im/LuisAlejandro/candyshop
           :alt: Gitter Chat
        
        |
        |
        
        .. _full documentation: https://candyshop.readthedocs.org
        
        Candyshop is a helper to determine if all your dependencies are declared
        properly. A Candyshop is a place where you can pick sweets and candies from
        a list of wonderful options, but choose wisely.
        
        For more information, please read the `full documentation`_.
        
        Features
        ========
        
        * Access an Odoo Module as an object abstraction.
        * Get all module references from all xml files of a module.
        * Generate and clone the dependency tree of a group of modules (bundle).
        * Generate a virtual enviroment where you can add group of modules.
        * Determine which Odoo Modules declare a dependency to another module that is not
          present in the environment.
        * Determine which XML files make reference to an Odoo Module that is not present
          in the environment.
        
        Getting started
        ===============
        
        Installation
        ------------
        
        .. _PyPI: https://pypi.python.org/pypi/candyshop
        
        The ``candyshop`` program is written in python and hosted on PyPI_. Therefore, you can use
        pip to install the stable version::
        
            $ pip install --upgrade candyshop
        
        If you want to install the development version (not recomended), you can install
        directlty from GitHub like this::
        
            $ pip install --upgrade https://github.com/LuisAlejandro/candyshop/archive/master.tar.gz
        
        Usage
        -----
        
        Here you can consult practical uses for some of the Candyshop functions.
        For a more detailed review on what you can do with it, we recommend you to read
        the `api` documentation.
        
        The ``Module`` class
        ~~~~~~~~~~~~~~~~~~~~
        
        The ``Module`` class is an abstraction of an Odoo Module. You can perform
        several operations to access the module information::
        
            from candyshop.bundle import Module
        
            # Create a Module instance
            module = Module('path/to/module')
        
            # Query for data
            print(module.path)
            print(module.manifest)
        
            # Query information in manifest file
            print(module.properties.name)
            print(module.properties.version)
            print(module.properties.depends)
        
        The ``Bundle`` class
        ~~~~~~~~~~~~~~~~~~~~
        
        The ``Bundle`` class is an abstraction of a *Group* of modules, often referred
        to as *Addons*. Here you can see how to interact with a bundle::
        
            from candyshop.bundle import Bundle
        
            # Create a Bundle instance
            bundle = Bundle('path/to/bundle')
        
            # Query for data
            print(bundle.name)
            print(bundle.path)
            print(bundle.modules)
            print(bundle.oca_dependencies)
        
        The ``Environment`` class
        ~~~~~~~~~~~~~~~~~~~~~~~~~
        
        The ``Environment`` class is an abstraction of a virtual Odoo Environment.
        Think of it as an imaginary container inside of which you can add ``Bundles``
        and ask for specific information about them. For example::
        
            from candyshop.environment import Environment
        
            # Create an Environment
            env = Environment()
        
            # Insert bundles
            # If any bundle has an oca_dependencies.txt file,
            # clone its dependencies and insert them as bundles
            env.addbundles(['./path-to-bundle', '../addons', '../etc'])
        
            # Make a report about dependencies that are not present in
            # the environment
            env.get_notmet_dependencies_report()
        
            # Make a report about record ids that reference modules
            # which are not present in the environment
            env.get_notmet_record_ids_report()
        
        Getting help
        ============
        
        .. _Gitter Chat: https://gitter.im/LuisAlejandro/candyshop
        .. _StackOverflow: http://stackoverflow.com/questions/ask
        
        If you have any doubts or problems, suscribe to our `Gitter Chat`_ and ask for help. You can also
        ask your question on StackOverflow_ (tag it ``pypicontents``) or drop me an email at luis@huntingbears.com.ve.
        
        Contributing
        ============
        
        .. _CONTRIBUTING.rst: CONTRIBUTING.rst
        
        See CONTRIBUTING.rst_ for details.
        
        
        Release history
        ===============
        
        .. _HISTORY.rst: HISTORY.rst
        
        See HISTORY.rst_ for details.
        
        License
        =======
        
        .. _COPYING.rst: COPYING.rst
        .. _AUTHORS.rst: AUTHORS.rst
        .. _GPL-3 License: LICENSE.rst
        
        Copyright 2016-2017, Candyshop Developers (read AUTHORS.rst_ for a full list of copyright holders).
        
        Released under a `GPL-3 License`_ (read COPYING.rst_ for license details).
        
        Made with :heart: and :hamburger:
        =================================
        
        .. image:: http://huntingbears.com.ve/static/img/site/banner.svg
        
        .. _Patreon: https://www.patreon.com/luisalejandro
        .. _Flattr: https://flattr.com/profile/luisalejandro
        .. _PayPal: https://www.paypal.me/martinezfaneyth
        .. _LuisAlejandroTwitter: https://twitter.com/LuisAlejandro
        .. _LuisAlejandroGitHub: https://github.com/LuisAlejandro
        .. _huntingbears.com.ve: http://huntingbears.com.ve
        
        |
        
        My name is Luis (`@LuisAlejandro`__) and I'm a Free and
        Open-Source Software developer living in Maracay, Venezuela.
        
        __ LuisAlejandroTwitter_
        
        If you like what I do, please support me on Patreon_, Flattr_, or donate via PayPal_,
        so that I can continue doing what I love.
        
            Blog huntingbears.com.ve_ · GitHub `@LuisAlejandro`__ · Twitter `@LuisAlejandro`__
        
        __ LuisAlejandroGitHub_
        __ LuisAlejandroTwitter_
        
        |
        |
        
Keywords: odoo,requirements
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
