Commit Graph

52 Commits

Author SHA1 Message Date
SET 6c4df66aeb Updated the README and generic example. 2020-08-15 11:02:12 -03:00
SET 07046f0d68 Updated README and generic example. 2020-08-13 23:07:21 -03:00
SET f231ac6835 Updated the README and the generic example. 2020-08-12 20:08:44 -03:00
SET 303bfb38fb Updated README.md and YAML example 2020-08-12 12:02:43 -03:00
SET fe2f5d6c65 Updated the documentation
Included new options: highlight_empty and max_col_width
2020-08-11 12:45:28 -03:00
Salvador E. Tropea 46c55fcf91 Separated the format specific options for internal BoM
And now we have more options.
- CVS: can quote all values.
- HTML and XLSX: styles adjust, including a logo.
- XLSX: now has the same options as HTML
Also a fix in the "join" mechanism for "case insensitive" support.
2020-08-05 19:57:32 -03:00
Salvador E. Tropea 99eab1c2f1 Removed `number_rows` from README.md and exampl config. 2020-08-01 18:42:01 -03:00
Salvador E. Tropea 6ac62e5053 Updated the README.md with the -v... fix 2020-07-31 12:00:08 -03:00
Salvador E. Tropea 544f34c6fc Added native BoM generator.
Based on KiBoM, but reading the data directly from the .sch
Information from the libs not supported yet.
2020-07-27 22:04:01 -03:00
Salvador E. Tropea 7dc94bf7be Added default output file name pattern.
Can be applied to all outputs.
2020-07-23 18:26:03 -03:00
Salvador E. Tropea 43b97db20c Now IBoM output file is coherent with other outputs.
The user can select the IBoM name mechanism, but the default is to use
a name coherent with all the other outputs.
2020-07-22 19:51:35 -03:00
Salvador E. Tropea 64bbf3d6e3 Updated the documentation and example.
- Output filenames changes.
- KiBoM configuration.
2020-07-22 18:35:24 -03:00
Salvador E. Tropea a1d5f62fcd Updated the README.md and added a brief YAML explanation. 2020-07-22 11:20:04 -03:00
Salvador E. Tropea 41de8c032c Added `output` option to control the file name to all plot output formats. 2020-07-12 13:00:38 -03:00
Salvador E. Tropea e2854ef524 Added gerber.gerber_job_file option to control the gerber job file name. 2020-07-12 12:28:00 -03:00
Salvador E. Tropea 63999aa009 Preflight filters parsed by Optionable class.
This makes the filters similar to output options.
- Adds coherence to error messages.
- Enable aliases (used the ones suggested by @leoheck)
Additionally now the README.md preflights documentation comes directly
from --help-preflights
2020-07-12 11:52:44 -03:00
Salvador E. Tropea 9fdc02ecea Added aliases for options.
The test case is the pdf_pcb_print.output_name, which is different than
other *.output options. Now output_name is an alias for output.
2020-07-12 09:41:16 -03:00
Salvador E. Tropea 52e6bb1b5f Added support for PcbDraw 2020-07-11 13:49:03 -03:00
Salvador E. Tropea 558ef81195 Updated Coveralls badge. 2020-07-09 18:50:04 -03:00
Salvador E. Tropea f72ff3f441 Extra dot in step.metric_units docstring.
Remove dead code in check_eeschema_do()
Fixed the way we read scale stuff from a PCB
Added special checks for check_script and check_version
2020-07-09 12:50:27 -03:00
Salvador E. Tropea 4368364489 Refactored the BaseOutput class to make it more similar to the YAML
Now the options are just an attribute of the outputs.
It means we have a set of classes for the options.
All the output content is parsed by the classes, including the Layers.
Now the layers support a simple string (with interesting shortcuts), a list of
strings or the original list of dicts.
2020-07-08 15:17:24 -03:00
Salvador E. Tropea 45ecb1d02a Added a mechanism to specify suboptions.
Now the legacy drill.map.type and drill.report.filename are specified in this
way.
The BaseOutput class now inherits from Optionable.
Suboptions are just Optionable classes.
Also: added traceback print when an error is reported and we are in debug mode.
2020-07-05 12:40:57 -03:00
Salvador E. Tropea ee11ecf8e7 Added number, variant, conf and separator KiBoM options. 2020-07-02 23:30:57 -03:00
Salvador E. Tropea 25730bce39 Added a note about inner layer names in the README.md
After analyzing all the forks I found that at least 6 forks tried to fix the
Inner.X vs InX.Cu difference.
Also one seems to add support for the names used by pcbnew, but breaks
compatibility with old config files.
2020-07-02 17:19:04 -03:00
Salvador E. Tropea 4538236574 Now outputs and preflights are loaded as plugins.
They can be added from ~/.config/kiplot/plugins/
Also sorted the preflights in the YAML example and allower -v for
--help-list-outputs, needed to know from where are the plugins loaded.
2020-07-02 12:30:30 -03:00
Salvador E. Tropea 1ca21efe94 Now the docstring for string options can specify a list of allowed values
This reduces the number of setters/getters we need to write.
On the other side the time to validate the YAML is increased.
2020-07-02 09:25:06 -03:00
Salvador E. Tropea ec35d2443f Added option to copy plot options from the PCB to the YAML example.
Also added DXF.metric_units and updated the README.
2020-07-01 20:43:03 -03:00
Salvador E. Tropea d926a5419e Added --example basic tests
Also added support for output directory to --example
2020-06-30 20:43:42 -03:00
Salvador E. Tropea 4ae54f3ded Added --example/-x option to generate a configuration example.
The example contains all the available preflights and outputs.
If the user specifies a PCB the names of the layers are from the provided PCB
2020-06-30 20:09:14 -03:00
Salvador E. Tropea 60a2649c0f Moved the dril_marks attribute to a separated class.
Reused by 5 output classes.
2020-06-29 20:10:40 -03:00
Salvador E. Tropea 3c6f4950c7 Now the schematic can be specified separately.
We now test if the PCB and/or SCH are there only when we need them.
2020-06-29 19:25:54 -03:00
Salvador E. Tropea 017f2ace47 Fixed redundant "Supported outputs" in the README and updated command line help 2020-06-29 12:57:06 -03:00
Salvador E. Tropea a436aea8e7 Now the README.md is sychronized using the help output.
The --help-outputs and --help are embedded in the README.md
To make it easier to read now options are enclosed in `` and the list of
outputs is sorted.
2020-06-27 18:28:05 -03:00
Salvador E. Tropea 7df1e9fe87 Added documentatio for the new output 2020-06-15 16:18:40 -03:00
Salvador E. Tropea 0d9256fb24 The 'check_zone_fills' option is now independent of 'run_drc'
Implemented in a different way.
For all internal commands now we use Python bindings to fill the zones as
suggested by @arikrupnik in johnbeard/kiplot#11
For 'print_pcb' now we ask KiCad to do it before printing (needs v1.4.1)
2020-06-14 15:12:56 -03:00
Salvador E. Tropea 4101f69cd4 Added support for compressed YAML files. 2020-06-14 11:05:08 -03:00
Salvador E. Tropea 157e23c998 Documented some regex tips from the discussion here: johnbeard/kiplot#18 2020-06-11 12:51:58 -03:00
Salvador E. Tropea a403e1b13b Documented the filters option. 2020-06-10 10:57:22 -03:00
Salvador E. Tropea 831b6e3418 Added test and covergage badges to README.md 2020-05-26 15:03:40 -03:00
Salvador E. Tropea 9ca072a9f1 Added --list option to the README and some information about odcker images and CI/CD 2020-04-24 09:59:16 -03:00
Salvador E. Tropea 7b13355949 Updated the usage instructions 2020-03-24 23:19:47 -03:00
Salvador E. Tropea c9fe26665d Added dependencies and how to run without installing 2020-03-24 14:48:08 -03:00
Salvador E. Tropea 64ab20e68e Finished the options documentation 2020-03-24 12:18:21 -03:00
Salvador E. Tropea 397cae4373 Modified the subitem style to match GitHub style 2020-03-24 00:07:11 -03:00
Salvador E. Tropea 7150549854 Started to document the configuration file 2020-03-24 00:03:47 -03:00
Salvador E. Tropea 3a401be170 Updated the README.md to the current functionality. 2020-03-10 15:11:24 -03:00
John Beard f1c85dbdba Document usage and example makefile 2018-11-27 11:06:05 +00:00
Kaspar Emanuel f09f253dca Improve virtualenv command suggestion in readme
The Python in the virtualenv doesn't know about pcbnew module.
When installed normally, this can be provided when setting up the
virtualenv. This lets you avoid messing about with PYTHONPATH.

The old instructions apply when KiCad is not installed to the
system (common when developing)
2018-08-23 15:27:08 +01:00
John Beard c4778e37bd Add a basic plot test 2018-07-31 17:36:56 +01:00
John Beard cc06a8ef66 MOre README tweaks@ 2018-06-03 15:46:47 +01:00