BoxesPy pour instance Profouzors
Go to file
Florian Festi ba4632dc77 Use thump nails in README
as Git Hub doesen't pass image attributes for some reason *sigh*
2021-05-23 18:12:53 +02:00
boxes New generator: SlattwallStairs 2021-05-23 13:00:52 +02:00
documentation I add images to README 2021-05-23 15:02:09 +02:00
examples examples/generate.sh: Remove no longer existing generator "box" 2020-03-07 20:22:27 +01:00
inkex Build and ship inkscape inx files 2017-02-25 20:01:03 +01:00
locale Update fr.mo 2020-11-16 22:49:32 +01:00
po Remove duplicated entries in translations files 2021-04-20 22:35:16 +02:00
scripts Show description above image in the web interface 2021-03-15 13:50:35 +01:00
static Add pictures for some slatwall generators 2021-04-28 22:31:00 +02:00
.gitignore ignore vscode and venv 2020-05-18 22:30:28 +02:00
.travis.yml Add affine to travis run 2020-05-22 10:35:40 +02:00
CODE_OF_CONDUCT.md Code of Conduct 2018-09-24 13:31:36 +02:00
CONTRIBUTING.rst CONTRIBUTING.rst: How to contribute pictures 2021-03-27 22:28:45 +01:00
LICENSE.txt Licence the code under GPLv3 2014-03-16 18:26:12 +01:00
MANIFEST.in Add translations files from zanata to the repository 2019-08-22 12:19:23 +02:00
README.rst Use thump nails in README 2021-05-23 18:12:53 +02:00
requirements.txt add requirements file 2020-07-30 22:15:57 +02:00
setup.py setup.py: Adjust to new Inkscape command line 2021-04-20 22:35:16 +02:00

README.rst

About Boxes.py
==============

.. image:: static/samples/NotesHolder-thumb.jpg
   :width: 18%
.. image:: static/samples/OttoBody-thumb.jpg
   :width: 18%
.. image:: static/samples/PaintStorage-thumb.jpg
   :width: 20%
.. image:: static/samples/ShutterBox-thumb.jpg
   :width: 20%
.. image:: static/samples/TwoPiece-thumb.jpg
   :width: 19%

* Boxes.py is an online box generator

  * https://www.festi.info/boxes.py/index.html

* Boxes.py is an Inkscape plug-in
* Boxes.py is library to write your own
* Boxes.py is free software licensed under GPL v3+
* Boxes.py is written in Python and runs with Python 3

Boxes.py comes with a growing set of ready-to-use, fully parametrized
generators. See https://florianfesti.github.io/boxes/html/generators.html for the full list.

.. image:: static/samples/AngledBox-thumb.jpg
   :width: 33%
.. image:: static/samples/FlexBox2-thumb.jpg
   :width: 33%
.. image:: static/samples/HingeBox-thumb.jpg
   :width: 33%

Features
--------

Boxes.py generates SVG images that can be viewed directly in a web browser but also
postscript and - with pstoedit as external helper - other vector formats
including dxf, plt (aka hpgl) and gcode.

Of course the library and the generators allow selecting the "thickness"
of the material used and automatically adjusts lengths and width of
joining fingers and other elements.

The "burn" parameter compensates for the material removed by the laser. This
allows fine tuning the gaps between joins up to the point where plywood
can be press fitted even without any glue.

Finger Joints are the work horse of the library. They allow 90° edges
and T connections. Their size is scaled up with the material
"thickness" to maintain the same appearance. The library also allows
putting holes and slots for screws (bed bolts) into finger joints,
although this is currently not supported for the included generators.

Dovetail joints can be used to join pieces in the same plane.

Flex cuts allows bending and stretching the material in one direction. This
is used for rounded edges and living hinges.

.. image:: static/samples/TypeTray-thumb.jpg
   :width: 33%
.. image:: static/samples/BinTray-thumb.jpg
   :width: 33%
.. image:: static/samples/DisplayShelf-thumb.jpg
   :width: 33%

.. image:: static/samples/AgricolaInsert-thumb.jpg
   :width: 33%
.. image:: static/samples/HeartBox-thumb.jpg
   :width: 33%
.. image:: static/samples/Atreus21-thumb.jpg
   :width: 33%

Documentation
-------------

Boxes.py comes with Sphinx based documentation for usage, installation
and development.

The rendered version can be viewed at <https://florianfesti.github.io/boxes/html/index.html>.