Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/FreeCAD/FreeCAD-macros

A repository for FreeCAD macros
https://github.com/FreeCAD/FreeCAD-macros

freecad freecad-macro

Last synced: 3 months ago
JSON representation

A repository for FreeCAD macros

Awesome Lists containing this project

README 

        
# FreeCAD-macros



A repository of peer-reviewed FreeCAD macros.



This repository hosts FreeCAD macros that volunteers have vetted and added for use to the whole community in general available through the [FreeCAD Addon Manager](https://www.freecadweb.org/wiki/AddonManager).



## How to submit a macro



- The best way to submit a macro is to post it to the [FreeCAD Python Scripting and Macros subforum](https://forum.freecadweb.org/viewforum.php?f=22) for review. After a green light is given then:



- Fork this repository

- Clone your fork locally `git clone https://github.com/your-gh-username/FreeCAD-macros`

- Go to the newly-created local repository `cd FreeCAD-macros`

- Setup the upstream `git remote add upstream https://github.com/FreeCAD/FreeCAD-macros`

- Create a branch to work in `git checkout -b your_branch`

- Follow our [guidelines](https://github.com/FreeCAD/FreeCAD-macros#guidelines-for-submitting-a-macro) below on how to add a macro

- When you're ready to push your changes: `git push -u origin your_branch`

- Create a PR (pull request) against upstream

- Achieve global fame once PR is merged



## Guidelines for submitting a macro



### Macro description

Please add a complete description how to use the macro near the top of your macro as normal Python comments.

Ideally write a Wiki page explaining what your macro does and how to use it by following the instructions on the [Wiki](https://wiki.freecadweb.org/Macro_documentation). It's a good habit to write a changelog, especially when bringing API breaking changes, from latest to oldest.



### CamelCase macro name

Please follow the `CamelCase.FCMacro` convention for the macro name (other associated files except the macro icon don't need to follow this convention). Please don't start your macro name with `Macro` or `FC` or similar (we already know it's a macro for FreeCAD).



### Macro name specifics

Also, if possible, start the macro name with the type of object it's working on, e.g. use `ViewRotation` instead of `RotateView`, so that all macros related to `View` will be together when sorting alphabetically.



### Macro metadata

Please add the following metadata in your macro after the Macro description (mentioned above). 



#### Macro metadata



```python

    __Name__ = ''

    __Comment__ = ''

    __Author__ = ''

    __Date__ = ''

    __Version__ = ''

    __License__ = ''

    __Web__ = ''

    __Wiki__ = ''

    __Icon__ = ''

    __Xpm__ = ''

    __Help__ = ''

    __Status__ = ''

    __Requires__ = ''

    __Communication__ = ''

    __Files__ = ''

```



#### Explanation of metadata



NOTE: All metadata elements are simple strings, and *may not contain code to evaluate*. The FreeCAD Addon Manager parses these strings by searching for an equals sign followed by something inside quotes (single or double), all on a single line. Lines may not wrap. For example:

```

# Good, valid

__Comment__ = "When run, this macro reads your mind and creates the thing your are imagining."



# Bad, contains code:

__Author__ = ",".join(author_list)



# Bad, not a single string:

__Comment__ = "Some descriptive text" + " and more text"



# Bad, multiple lines:

__Files__ = "MyFirstFile.FCMacro \

MySecondFile.FCMacro"



# EXCEPTION: __Version__ may be set to __Date__ as long as __Date is defined first

__Date__ = 2022.05.19

__Version__ = __Date__



# EXCEPTION: XPM data must be a triple-quoted multi-line string

__Xpm__ = """

/* XPM */

static char * XFACE[] = {

"48 4 2 1",

"a c #ffffff",

"b c #000000",

"abaabaababaaabaabababaabaabaababaabaaababaabaaab",

"abaabaababaaabaabababaabaabaababaabaaababaabaaab",

"abaabaababaaabaabababaabaabaababaabaaababaabaaab",

"abaabaababaaabaabababaabaabaababaabaaababaabaaab"

};

"""

```



* `__Name__` - The name of the macro, for display by the Addon Manager. Generally the filename of the macro without extension, and with spaces between words. For example, the macro file "DxfToSketchLayers.FCMacro" becomes "DXF to Sketch Layers"

* `__Comment__` - A description of what the macro does. Displayed and searched by the Addon Manager.

* `__Author__` -  Comma-separated list of authors (as a single string, e.g. "Jane Doe, John Smith, Bobbi Jones")

* `__Version__` - Use semantic versioning (1.2.3-beta), or CalVer (2022.05.19)

* `__Date__` - The date of the last update, YYYY-MM-DD

* `__License__` - 'License identifier from https://spdx.org/licenses/, e.g. LGPL-2.0-or-later as FreeCAD, MIT, CC0-1.0'

* `__Web__` - A URL to fetch the macro from

* `__Wiki__` - The wiki page (generally at https://wiki.freecad.org) describing the macro, and displayed as the "Details" page in the Addon Manager.

* `__Icon__` - Either a relative path to an icon file included in the FreeCAD macros repository, or a URL where the icon may be downloaded from. Must be a direct download of an image file.

* `__Xpm__` - (OPTIONAL) Instead of specifying an `__Icon__`, icon data may be set directly as a triple-quoted string containing XPM data.

* `__Help__` - A short explanation how to use the macro, e.g. what to select before launching

* `__Status__` - Stable|Alpha|Beta

* `__Requires__` - e.g. FreeCAD >= v0.17, there is no programmatic use of this for now

* `__Communication__` - e.g. https://github.com/FreeCAD/FreeCAD-macros/issues/ if on the github

* `__Files__` - comma-separated list of files that should be installed together with this file, use paths relative to this file, do not include this file, and do not wrap the line, all files must be listed in the same single-line quoted string.