fossasia / ayabinterface Goto Github PK

The documentation links to files in a specific line.
These lines should be fixed so the documentation does not become invalid when the firmware is changed. A possible, easy way is:

• make sure all arduino software links point to a commit.

In the requirements.in and requirements.txt there is a dependency to the knittingpattern package. This is only necessary for the readthedocs build. This is unnecessairy and can be removed.

Objective:

• remove the knittingpattern dependency
• make readthedocs work, still.

Possible Solution:

Create a docs-requirements.in file and docs-requirements.txt file that includes all that is required for the cods to build.

The package should be able to configure a new Arduino.

• the firmware is delivered with the package
• it is possible to flash the firmware
  • the type uno or mega can be selected
  • if possible, auto-select them
• flashing works in windows
• flashing works in linux
• flashing works in mac
• an issue is created to flash the firmware in the kniteditor

Knitting pattern conversion is done here.
We should test and implement

• increases, decreases
• holes
• errors of wrong instructions are taken
• a way to convert incoming knitting patterns to the subset that is possible to knit
• add the actions to perform by the user

Currently, the communication object only takes a callable as get_needle_positions.
Extend this to

• take a callable, like now
• take an object like NeedlePositions and Interaction
  • the on_message_received method should be registered automatically
• a list. (put list to get_needle_positions) into it own function

Hints:

• document, test, mock, implement

Implement a wireless mode via WIFI with the interface of the serial module.

• create connections via tcp
• update the listing in the background
  • expect and document first, that you use broadcast/multicast sockets
• create an issue for the firmware to become able to support this kind of communication

Add these badges to this repository:

.. # |downloads| image:: http://img.shields.io/pypi/dm/knitlib.png?style=flat
:alt: PyPI Package monthly downloads
:target: https://pypi.python.org/pypi/knitlib

.. # |wheel| image:: https://pypip.in/wheel/knitlib/badge.png?style=flat
:alt: PyPI Wheel
:target: https://pypi.python.org/pypi/knitlib

.. # |supported-versions| image:: https://pypip.in/py_versions/knitlib/badge.png?style=flat
:alt: Supported versions
:target: https://pypi.python.org/pypi/
.. # |supported-implementations| image:: https://pypip.in/implementation/knitlib/badge.png?style=flat
:alt: Supported imlementations
:target: https://pypi.python.org/pypi/knitlib

.. # |scrutinizer| image:: https://img.shields.io/scrutinizer/g/tian2992/knitlib/master.png?style=flat
:alt: Scrutinizer Status
:target: https://scrutinizer-ci.com/g/tian2992/knitlib/

In order to debug whole test runs, we should create a virtual machine.

• communication via blocking bytes io
• integration tests
• parallel execution
• load pattern from file and knit it

readthedocs is not building. It should build again.
Sometimes they build and sometimes they do not.
https://readthedocs.org/projects/kniteditor/builds/

Fix this for

• knittingpattern
• AYABInterface
• kniteditor

Hints:

• This may have to do with installing pillow of different versions.

The Arduinos need drivers.

1. should the drivers be delivered with the package?
2. how to install them?
3. do we need to install the arduino software?
4. how does it work in windows?
5. how does it work in linux?
6. how does it work in mac?

When answering these questions, please refer to the number.

a cached_property is lie a property but computes its value only once.

• add cached_property
• use it in the interactions module
• it should appear in the docs like the property does

The actions should be translated. Localization and filling in values can work like this:

action.translate(gettext)
action.english()  # returns the English string (default)

gettext is a gettext.gettext instance.