Metadata-Version: 2.1
Name: Payton
Version: 0.0.2
Summary: Payton 3D Kickstart Toolkit
Home-page: https://github.com/sinanislekdemir/payton
Author: Sinan ISLEKDEMIR
Author-email: sinan@islekdemir.com
License: LICENSE
Description: # Payton
        
        ## What is Payton?
        
        Payton is a general purpose 3D programming toolkit. It is designed with the
        theory that us, humans, we understand better by seeing things.
        
        
        * Payton is a prototyping tool. Kickstart any idea fast and easy, grow it.
        * Create tools for the next step. Create maps editors, small animations, small algorithms or artificial intelligence for your game. Whenever you need
        to try a new idea, don't bother to create a new application with all the details. Payton comes with all the necessary defaults and that is what makes it unique. Almost everything has a pre-set.
        * Game engines and other libraries are way too complex and it takes a long time to start the initial playground.
        * Payton never intends to take place as a game engine or a full-featured 3D environment. There are already plenty of stuff for that purpose.
        * Tools programming is easy.
        * Easy to visualise what you want to achive or do what you want to do.
        * You can move forward from Payton to any other place if you like.
        
        
        We draw 2D graphs and charts in reports and we generally understand much more
        easily when we visualise the data. But in some cases, visualising exceeds 2
        dimensions. We require to have third and even forth dimensions. (And on top of
        those, definition of forth dimension as time can get foggy in terms of
        relativity.)
        
        Payton gives you ability to extend your graphics into 4 dimensions. It is not
        a software but a software development toolkit/library built with Python.
        This will give users ability to read real time data from sensors, cameras or
        any other data sources in realtime and visualise them in real time. Data source
        can be a thermometer, a random number generator, a toy car connected to a speed
        sensor, a map, a vehicle port or anything that generates time based 3d data.
        Further more, it can be a time based formula. As this can get too complex,
        a software with that complexity will probably be too hard to use and understand
        where Payton is designed to be as simple as it can be. So easy to program that
        a newbie can kick-start it just by following the tutorials.
        
        More information can be found in documents.
        
        ## Development
        
        Some notes on Python3:
        
        Currently Payton is in pre-alpha, or it is just some dust cloud in the space.
        If you want to contribue, here is what you can do:
        
        You can generate the API documentation using PDOC
        (https://github.com/mitmproxy/pdoc). PDOC is not defined in setup.py or in
        requirements so you need to install pdoc yourself. (PDoc requires Python3)
        
        `pdoc --html payton` will create API docs for you. (Api docs are generated
        from comments and code itself, so keep comments in the code as descriptive
        as possible.)
        
        I encourage you to create a virtualenv for Payton (with Python 3.5+)
        
        `virtualenv -p <path-to-python3> payton` should do the trick. If you don't have
        `virtualenv` in your path, google it!
        
        To start to fiddle with it, `python setup.py develop` will install all
        requirements and will add `payton` to site-packages. But changes to code will
        immediately take effect. (Rather than `install` command).
        
        To kick start, after `python setup.py develop` run `python examples/04_clock.py`
        
        And once you see the white ball on the screen, hit `SPACE` from keyboard to unpause
        the animation mode and see the projectile motion demo.
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
