History

Chris Palmer 06e1c1a3da Documented project description blurb and openscad.py.		2020-12-29 12:20:32 +00:00
..
blurb.py	Project blurb can now be split with into sections with markdown horizonal rules	2020-12-28 20:49:37 +00:00
bom.py	make_all.py now terminates early if there are any errors in bom generation.	2020-04-29 15:19:10 +01:00
c14n_stl.py	Added usage messages to all the scripts and documented multiple configuration	2020-03-11 23:09:03 +00:00
deps.py	Fix handling of Windows paths with spaces	2020-03-15 16:25:18 +00:00
doc_scripts.py	Documented project description blurb and openscad.py.	2020-12-29 12:20:32 +00:00
dxfs.py	Set execute attributes on scripts for Linux.	2019-08-18 14:29:15 +01:00
exports.py	Now uses the dependencies to locate modules for printed parts and assemblies.	2020-03-12 22:47:27 +00:00
gallery.py	Added descriptions to doc_scripts.py and gallery.py.	2020-03-15 16:11:27 +00:00
make_all.py	Single backtick now used for all code quotes.	2020-12-24 16:04:59 +00:00
openscad.py	Documented project description blurb and openscad.py.	2020-12-29 12:20:32 +00:00
options.py	SHOW_THREADS renamed NOPSCADLIB_SHOW_THREADS for #61	2020-03-01 19:10:40 +00:00
panels.py	Single backtick now used for all code quotes.	2020-12-24 16:04:59 +00:00
plateup.py	Fixed recent bug in plateup when no platters / panels.	2020-11-15 16:29:50 +00:00
platters.py	Single backtick now used for all code quotes.	2020-12-24 16:04:59 +00:00
readme.md	Documented project description blurb and openscad.py.	2020-12-29 12:20:32 +00:00
render.py	Renders of dxfs now use the sheet colour.	2020-04-07 22:07:28 +01:00
set_config.py	Added usage messages to all the scripts and documented multiple configuration	2020-03-11 23:09:03 +00:00
stls.py	Set execute attributes on scripts for Linux.	2019-08-18 14:29:15 +01:00
svgs.py	Added documentation for the Python scripts.	2019-06-11 15:33:13 +01:00
tests.py	Single backtick now used for all code quotes.	2020-12-24 16:04:59 +00:00
times.py	Fixed bug updating the times file when case changes.	2020-04-13 18:02:03 +01:00
views.py	Project blurb can now be split with into sections with markdown horizonal rules	2020-12-28 20:49:37 +00:00

readme.md

Python scripts

These are located in the scripts subdirectory, which needs to be added to the program search path.

They should work with both Python 2 and Python 3.

Script	Function
`bom.py`	Generates BOM files for the project.
`c14n_stl.py`	OpenSCAD produces randomly ordered STL files. This script re-orders them consistently so that GIT can tell if they have changed or not.
`doc_scripts.py`	Makes this document and doc/usage.md.
`dxfs.py`	Generates DXF files for all the routed parts listed on the BOM or a specified list.
`gallery.py`	Finds projects and adds them to the gallery.
`make_all.py`	Generates all the files for a project by running `bom.py`, `stls.py`, `dxfs.py`, `render.py` and `views.py`.
`openscad.py`	Run `openscad.exe` and capture `stdout` and `stderr` in `openscad.log` as well as printing to the console.
`panels.py`	Panelises DXF files so they can be routed together by running scad files found in the `panels` directory.
`platters.py`	Generates build plates of STL files for efficient printing by running scad files found in the `platters` directory.
`render.py`	Renders STL and DXF files to PNG for inclusion in the build instructions.
`set_config.py`	Sets the target configuration for multi-target projects that have variable configurations.
`stls.py`	Generates STL files for all the printed parts listed on the BOM or a specified list.
`svgs.py`	Generates SVG files for all the routed parts listed on the BOM or a specified list.
`tests.py`	Runs all the tests in the tests directory and makes the readme file with a catalog of the results.
`views.py`	Generates exploded and unexploded assembly views and scrapes build instructions to make readme.md, readme.html and printme.html files for the project.