Metadata-Version: 1.2
Name: geometrical-layout
Version: 0.1.0
Summary: This client library is designed to help query endpoints of the "Dowell Geometrical Layout of Big Data API"
Home-page: https://github.com/DoWellUXLab/DoWell-Geometrical-layout-of-Big-Data
Maintainer: Abdullahi Abdulwasiu
Maintainer-email: abdullahiabdulwasiu1@gmail.com
License: Apache
Description: ============================================
        Dowell Geometrical Layout Python SDK Library
        ============================================
        
        This client is designed for the Dowell Geometrical Layout of Big Data API `Geometrical Layout Api`_.
        By specifying the radius, length, and width, users can determine the number of circles
        that can be arranged in a triangular packaging, minimizing wastage of space.
        The coordinates of the circle can also be determine.
        
        
        
        ============
        Installation
        ============
        
        This library currently supports Python 3.5+. The `requests`_ package is required.
        
        We recommend using `pip`_ and `virtualenv`_ for Installation. Please note
        that the Python package is called **geometrical-layout**.
        
        Installing a Released Version
        =============================
        
        .. code-block:: shell
        
            virtualenv env
            source env/bin/activate
            pip install geometrical-layout
        
        **Example**
        
        .. code-block:: python
        
            from geometrical_layout import GeometricalLayoutApi
            req = GeometricalLayoutApi()
        
        
        Methods
        -------
        
        post_object
        -----------
        The endpoint receive a json object of radius, length, width.
        Resonse is ``dict`` containing number of circles and coordinates. 
        
        
        **Parameters**
        
        * ``radius`` - A ``float`` or an ``int`` that identifies a circle radius, is needed
          to make API calls.
         
        * ``length`` - An ``int`` denoting the length of the space in canvas
        
        * ``width`` - A ``int`` denoting the length of the space in canvas.
          is the last parameter needed to make API request.
        
        
        **Examples**
        
        .. code-block:: python
        
            # Get the number of circles from the response.
            numberOfcircle = req.post_object(radius, length, width)
            print(numberOfcircle)
        
        
        
        Licensing
        =========
        
        This library uses the `Apache License, version 2.0`_. Please see the library's
        individual files for more information.
        
        .. _Apache License, version 2.0: https://www.apache.org/licenses/LICENSE-2.0
        
        
        Support & Discussion
        ====================
        For Support and Discussion, visit the official DoWellUXLab website.
        Documentation is available at https://geometrical-layouts.readthedocs.io/en/latest/index.html
        
        
        .. _Geometrical Layout Api: https://github.com/DoWellUXLab/DoWell-Geometrical-layout-of-Big-Data
        .. _requests: https://pypi.python.org/pypi/requests
        .. _pip: https://pip.pypa.io/
        .. _virtualenv: https://virtualenv.pypa.io/
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
