boxespy

BoxesPy pour instance Profouzors

Go to file

caleb crome 28959c098e Fix boxesserver commit `0a8dcf0e37` caused the server to only respond to localhost by default. This causes the Docker to not respond properly. The old server had the default server name as '', but the new one set it to 'localhost'. This fixes that problem. In addition, This commit changes the docker file so that you can specify which git repo and commit to check out from. This allows trivial testing of other clones. The default branch is master and default git repo is Florian's, but you can now specify new commits and/or branches to clone with ```docker build --build-arg BUILD_BRANCH=<branch-or-commit> --build-arg BUILD_REPO=<my-repo>```		2023-01-17 10:28:23 +01:00
.github	Add dependabot configuration	2023-01-16 20:43:49 +01:00
boxes	SmallPartsTray2: Add back_height parameter	2023-01-16 18:58:15 +01:00
documentation	Use `format()`	2023-01-13 16:18:44 +01:00
examples	Fix misspelled variables (#484 )	2023-01-02 16:23:24 +01:00
inkex	Build and ship inkscape inx files	2017-02-25 20:01:03 +01:00
locale	Update language files	2023-01-05 15:59:14 +01:00
po	Update language files	2023-01-05 15:59:14 +01:00
scripts	Fix boxesserver	2023-01-17 10:28:23 +01:00
static	BreadBox: Declare stable and add sample image	2023-01-14 00:05:02 +01:00
.gitattributes	Create .gitattributes	2022-09-06 18:52:06 +02:00
.gitignore	ignore vscode and venv	2020-05-18 22:30:28 +02:00
CODE_OF_CONDUCT.md	Code of Conduct	2018-09-24 13:31:36 +02:00
CONTRIBUTING.rst	Document where all to add new dependencies	2022-07-17 14:11:25 +02: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	More tables	2021-05-23 19:08:38 +02:00
requirements.txt	Fix missing version in `requirements.txt`	2022-12-27 21:42:48 +01:00
setup.py	Remove support of EOL Python 3.6	2022-12-27 21:43:41 +01:00

README.rst

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

+----------------------------------------------+----------------------------------------------+----------------------------------------------+----------------------------------------------+----------------------------------------------+
| .. image:: static/samples/NotesHolder.jpg | .. image:: static/samples/OttoBody.jpg | .. image:: static/samples/PaintStorage.jpg | .. image:: static/samples/ShutterBox.jpg | .. image:: static/samples/TwoPiece.jpg |
+----------------------------------------------+----------------------------------------------+----------------------------------------------+----------------------------------------------+----------------------------------------------+

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

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.jpg | .. image:: static/samples/BinTray.jpg | .. image:: static/samples/DisplayShelf.jpg |
+----------------------------------------------+----------------------------------------------+----------------------------------------------+
| .. image:: static/samples/AgricolaInsert.jpg | .. image:: static/samples/HeartBox.jpg | .. image:: static/samples/Atreus21.jpg |
+----------------------------------------------+----------------------------------------------+----------------------------------------------+

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