Skip to content

sadikkuzu/squiral

Repository files navigation

squiral

made-with-python Downloads
pre-commit.ci status Python lint&test Publish Python Package
Sourcegraph codecov

square spiral

Welcome to Squiral!
Here is an example:
21 22 23 24 25
20  7  8  9 10
19  6  1  2 11
18  5  4  3 12
17 16 15 14 13

squiral is a simple and lightweight Python library for generating square spiral patterns.
With squiral, you can easily create a wide range of square spiral designs, from simple to complex.

squiral is easy to use and integrate into existing projects,
making it a great tool for data visualization, computer graphics, and other applications.
With squiral, you can quickly and easily generate square spiral patterns
that are both beautiful and functional.
Whether you're working on a personal project or a professional one,
squiral's square spiral generator is the perfect tool
for adding unique and visually striking designs to your work.

The basic idea behind printing this matrix is
to start from the middle of the matrix and then moving:
right >> down >> left >> up
and not returning to the same row again.

Install

pip install squiral
pip install git+https://github.com/sadikkuzu/squiral.git

Usage

In console:

buddha@dharma:~$ squiral 7
43 44 45 46 47 48 49
42 21 22 23 24 25 26
41 20  7  8  9 10 27
40 19  6  1  2 11 28
39 18  5  4  3 12 29
38 17 16 15 14 13 30
37 36 35 34 33 32 31
buddha@dharma:~$ squiral --help
usage: squiral [-h] size

positional arguments:
  size        squiral size

optional arguments:
  -h, --help  show this help message and exit

In python:

>>> import squiral as sq
>>> sq.printout(sq.produce(5))
21 22 23 24 25
20  7  8  9 10
19  6  1  2 11
18  5  4  3 12
17 16 15 14 13
>>>

Contributing

To learn more about making a contribution to squiral, please see our Contributing guide

Many Thanks To Our Contributors