{ "info": { "author": "Sebastian Oliva , Shiluka Dharmasena", "author_email": "code@sebastianoliva.com , shiluka@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX", "Operating System :: Unix", "Programming Language :: Python", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Utilities" ], "description": "===============================\nknitlib\n===============================\n\n.. | |docs| |travis| |appveyor| |coveralls| |landscape| |scrutinizer|\n.. | |version| |downloads| |wheel| |supported-versions| |supported-implementations|\n\n| |travis| |docs|\n\n\n.. image:: https://badge.waffle.io/fashiontec/knitlib.png?label=ready&title=Ready\n :target: https://waffle.io/fashiontec/knitlib\n :alt: 'Stories in Ready'\n\n.. |docs| image:: https://readthedocs.org/projects/knitlib/badge/?style=flat\n :target: https://readthedocs.org/projects/knitlib\n :alt: Documentation Status\n\n.. |travis| image:: http://img.shields.io/travis/fashiontec/knitlib/master.png?style=flat\n :alt: Travis-CI Build Status\n :target: https://travis-ci.org/fashiontec/knitlib\n\n.. # |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/tian2992/knitlib?branch=master\n :alt: AppVeyor Build Status\n :target: https://ci.appveyor.com/project/tian2992/knitlib\n\n.. # |coveralls| image:: http://img.shields.io/coveralls/tian2992/knitlib/master.png?style=flat\n :alt: Coverage Status\n :target: https://coveralls.io/r/tian2992/knitlib\n\n.. # |landscape| image:: https://landscape.io/github/tian2992/knitlib/master/landscape.svg?style=flat\n :target: https://landscape.io/github/tian2992/knitlib/master\n :alt: Code Quality Status\n\n.. # |version| image:: http://img.shields.io/pypi/v/knitlib.png?style=flat\n :alt: PyPI Package latest release\n :target: https://pypi.python.org/pypi/knitlib\n\n.. # |downloads| image:: http://img.shields.io/pypi/dm/knitlib.png?style=flat\n :alt: PyPI Package monthly downloads\n :target: https://pypi.python.org/pypi/knitlib\n\n.. # |wheel| image:: https://pypip.in/wheel/knitlib/badge.png?style=flat\n :alt: PyPI Wheel\n :target: https://pypi.python.org/pypi/knitlib\n\n.. # |supported-versions| image:: https://pypip.in/py_versions/knitlib/badge.png?style=flat\n :alt: Supported versions\n :target: https://pypi.python.org/pypi/knitlib\n\n.. # |supported-implementations| image:: https://pypip.in/implementation/knitlib/badge.png?style=flat\n :alt: Supported imlementations\n :target: https://pypi.python.org/pypi/knitlib\n\n.. # |scrutinizer| image:: https://img.shields.io/scrutinizer/g/tian2992/knitlib/master.png?style=flat\n :alt: Scrutinizer Status\n :target: https://scrutinizer-ci.com/g/tian2992/knitlib/\n \n==================\n1. What is Knitlib\n==================\nKnitlib is a library designed to support the operation of varied knitting machines, mechanisms, and hacks. Knitlib is based on projects like AYAB, PDD, and KnitterStream to control knitting machines. Knitlib features a plugin system for knitting machines and implements an API to control machines' operation, knitting jobs and knitting patterns. The software is based on Python. There also is a Web API. Among the primary tasks is to develop plugins based on this solution to add support for more machines.\n\n1.1 Idea behind Knitlib\n-----------------------\n\n1.2 Technical Background of Knitlib\n-----------------------------------\n\nKnitlib is implemented as a Python Library and API. Each machine is supported via a Plugin, allowing for extensibility. Each of the plugins is based on a simple Finite State Machine, with states from machine initialization to operation and knitting process. Among the aplications using the Knitlib API is Knitlib-server, implementing a Webserver and REST / WebSocket endpoints. Clients can also implement message callbacks, errors, notifications and blocking messages in order to provide a good user experience.\n\n==========================\n2.Development Installation\n==========================\n\n pip install -r requirements.txt\n pip install knitlib\n\n========\n3. Usage\n========\n\n==============\n4. Development\n==============\n\nTo run the all tests run::\n\n tox\n \n=============\n5. References\n=============\n\n================\n6. Documentation\n================\n\n.. https://knitlib.readthedocs.org/\n\n===============\n7. Contributing\n===============\n\n7.1. Bug reports\n----------------\n\nBugs can be reported via the Github issues tracker at https://github.com/fashiontec/knitlib/issues\n\n7.2 Documentation improvements\n------------------------------\n\n7.3 Feature requests, Issues, and Feedback\n-----------------------------------------------\nIssues, feature requests and feedback can be reported via the Github issues tracker at https://github.com/fashiontec/knitlib/issues\n\n\n\n7.4 Pull Request Guidelines\n---------------------------\n\n\n\n=============================\n8. Applications using Knitlib\n=============================\n\n==========\n9. License\n==========\n\nFree software: LGPLv3+ license\n\n=========\nChangelog\n=========\n\n0.0.1 (2015-05-15\n-----------------------------------------\n\n* First release on PyPI.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/fashiontec/knitlib", "keywords": null, "license": "GPLv3", "maintainer": null, "maintainer_email": null, "name": "knitlib", "package_url": "https://pypi.org/project/knitlib/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/knitlib/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/fashiontec/knitlib" }, "release_url": "https://pypi.org/project/knitlib/0.0.1/", "requires_dist": null, "requires_python": null, "summary": "A library designed to support varied knitting machines.", "version": "0.0.1" }, "last_serial": 1704193, "releases": { "0.0.1": [] }, "urls": [] }