Knitting Projects

FOSSASIA has several open-source knitting projects. Here, you find an overview over these projects. You can get started developing on the projects or just check them out and install them. In case you are interested to connect with people, you can get in touch with us :). If you are interested in related work, look here.

List of Knitting Projects

Here you can find a list of knitting projects in the FOSSASIA organization:

kniteditor View on Github

The Knit Editor is an editor for the knit exchange format. It allows creating digital knit works from images and knitting it with several knitting machines.

This kniteditor is developed together with All Yarns Are Beautiful. You can download the releases and install them.

Read about the project:

Related Projects: knittingpattern, AYABInterface

Contribute: Tutorial Videos, Repository Issues Ready to Work on Read the Documentation Travis Build Status AppVeyor Build Status Code Climate Test Coverage Code Issue Count Code Health Python Package Index Version Python Package Index Downloads

knittingpattern View on Github

The knittingpattern is a Python library for an exchange format for knit work. It allows specifying how to knit a particular piece of work.

Read about the project:

Related Projects: AYABInterface, kniteditor

Contribute: Tutorial Videos, Repository Issues Ready to Work on Read the Documentation Travis Build Status AppVeyor Build Status Code Climate Test Coverage Code Issue Count Code Health Python Package Index Version Python Package Index Downloads

AYABInterface View on Github

The AYABInterface is used by the Knit Editor to convert knittingpatterns into machine instructions. It can be used standalone without these other projects. You can

Read about the project:

Related Projects: knittingpattern, kniteditor

Contribute: Tutorial Videos, Repository Issues Ready to Work on Read the Documentation Travis Build Status AppVeyor Build Status Code Climate Test Coverage Code Issue Count Code Health Python Package Index Version Python Package Index Downloads

knitting.fossasia.org View on Github

This is this overview site over the different knitting projects and aims at introducing new people to the community. You can

Read about the project:

Contribute: Repository Issues Ready to Work on

circle-knitting View on Github

There are commercial circular knitting machines, that are nearly completely made from plastic. A popular modul is the Addi Express. Plastic can be easily printed out on 3D printers. This project implements the idea to code a circular knitting machine. As inexpensive small PCs components like the Rapsberry PI and Arduinos become increasingly powerful there is even an option to include them as optional components in such a 3D printed knitting machine. You can

Contribute: Repository Issues Ready to Work on

knitweb View on Github

knitweb is an app frontend and backend that works together with the knitlib server and uses the knitpat format.

Related Projects: knitlib, knitpat, knitserver

Read about the project:

Contribute: Repository Issues Ready to Work on

knitlib View on Github

Knitlib 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.

Read about the project:

Related Projects: knitpat, knitweb, knitserver

Contribute: Repository Issues Ready to Work on Read the Documentation Travis Build Status

knitserver View on Github

Knitserver is a Knitlib client that provides REST API endpoints for knitting machine software and control. Knitserver is designed to interact with Knitweb.

Related Projects: knitlib, knitpat, knitweb

Contribute: Repository Issues Ready to Work on

How to Contribute

You can have various reasons to contribute to the software. This section aims to give you an overview over ways to get started.

The projects listed on this page have a Contribute: section which includes links for developers such as tutorial videos. In the following we will clarify how you can use them to jump into development. If you have any questions, please get in touch :)

For Beginners

All these projects are hosted on github. They use git to control every version of the software. In order to contribute, please first get to know git and github. Therefore, you can do tutorials:

Translate

A majority of people on earth do not speak English. By translating software, you make it accessible to thousands of people.

You can add translations to these projects:

Improve Metrics

Improving code metrics requires coding but not the understanding of how the code works. You learn how to set up this specific environment, fix some code and while doing this, you read it and get familiar with it. When your pull request is merged, you have contributed to the health of the project.

Some of the repositories have code metrics like code coverage and code quality. They can be improved easily. E.g. in this example you can find this error:

            bbox = list(map(lambda f: f*zoom, layout.bounding_box))
    missing whitespace around arithmetic operator

This can fix this by adding spaces around the operator.

Solve Issues

All the projects have "issues" attached to them. They show bugs and feature requests. A solved issue improves the life of somebody on earth. When solving the issue, you are introduced to the development process of the project and learn how to adapt the project to your needs.

Issues can be found in the issue tracker of github. You can find them through the "Repository" links of the projects or by clicking these badges:
knitting.fossasia.org-waffle-badge
The badge above links to the overview of all listed projects. If you find an issue which interests you, please comment that you would like to work on it. This way, you get help and it is not done twice.

Issues can be easy. You may pick those first to get into the project. Issues can have multiple bullet points or check boxes. You do not need to solve all of them. You can choose one and solve it.

The projects have tests and documentation:
Test Coverage Read the Documentation
Code should be documented and tested. Consider trying out documentation driven development, Test-First and test-driven development.

Get in Touch

FOSSASIA has a Slack to chat in the community. You can use the main channel or #knitting.

You can contact me directly. I started this site. You can find me on github and Slack under the name "niccokunzmann".

There is a mailing list for knitting applications such as these listed. You can also join the FOSSASIA mailing list.

You can comment on issues and through these reach the developers directly.

We have a Gitter chat which you can join: Join the chat at https://gitter.im/fashiontec/knitapps

For a broad overview on how to join FOSSASIA, see the FOSSASIA labs.

Related Work

This section contains links and related projets and work in the field of knitting. Additionally, other overview sites are listed here.

ayab-apparat View on Github

This Software is a predecessor of the Knit Editor. It is written in Python and Qt. AYAB maintains this project. The 2016 Google Summer of Code Project forked this repository and added the issues for the kniteditor, knittingpattern and AYABInterface.

Contribute: Repository

Links

These are links to other projects and overview sites. The objective is to ease exploring the network of people and projects.

Outdated Projects

These projects are a bit older, obsoleted or not maintained any more.

knitpat View on Github

knitpat contains a pattern definition format for knit work. It is the predecessor of the knittingpattern library.

Related Projects: knitlib, knitserver, knitweb

Contribute: Repository Issues Ready to Work on

knitapps View on Github

An older version of this overview site.

Contribute: Repository Issues Ready to Work on