Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a mechanism to rename columns #120

Merged
merged 2 commits into from
May 24, 2021

Conversation

set-soft
Copy link
Contributor

Description

Column names displayed in the table head are the names of the KiCad fields or the internal names used by KiBoM.
Sometimes the names aren't pretty. As an example is common to use manf# for the part name used by the component manufacturer.
Using long names for KiCad fields is a bad idea.

This patch allows to rename the columns names so you can use pretty names in the headings.

You must define a COLUMN_RENAME section in the configuration file.
Then add entries with the name of the original field and the name you want, separated by a tab (ASCII 9).
Here is an example:

[COLUMN_RENAME]
manf#	Manufacturer part number

Note that you must use a tab as separator. Using a space won't work because Manufacturer part number also has spaces.

Limitations

The separator must be a tab.

Additional notes

  • This patch also makes the prefs.ignore list lowercase.
    This is to avoid converting it to lower case all the time.
  • prefs.colRename is a hash. I saw that various preference options should also be a dict instead of a list.

@set-soft set-soft mentioned this pull request Jul 30, 2020
@Niels-Be
Copy link

what is the hold up here?
I would really like to see this merged

@set-soft
Copy link
Contributor Author

Perhaps @SchrodingersGat doesn't really like my implementation. But you can always use:

  1. My fork, I try to keep it synced with this repo. So you can think about it as the experimental branch.
  2. The KiBot internal BoM output. It has more options and flexibility. But it also has a lot of limitations (only Linux, not a plug-in).

@SchrodingersGat
Copy link
Owner

@set-soft sorry for the delay on this, it had completely fallen off my radar.

If you can please fix the conflicts with preferences.py I would be happy to merge.

@BillyPocketNC
Copy link

@set-soft @SchrodingersGat ,
What needs to change to get this merged?

- **Pull-request**: [SchrodingersGat#82](SchrodingersGat#82)
- **Opened**: 2020-03-18
- **Status**: Open
- **Branch**: column_rename

-## Description

Column names displayed in the table head are the names of the KiCad fields or the internal names used by KiBoM.
Sometimes the names aren't pretty. As an example is common to use `manf#` for the part name used by the component manufacturer.
Using long names for KiCad fields is a bad idea.

This patch allows to rename the columns names so you can use pretty names in the headings.

You must define a `COLUMN_RENAME` section in the configuration file.
Then add entries with the name of the original field and the name you want, separated by a tab (ASCII 9).
Here is an example:

```
[COLUMN_RENAME]
manf#	Manufacturer part number
```

Note that you must use a tab as separator. Using a space won't work because *Manufacturer part number* also has spaces.

-## Limitations

The separator must be a tab.

-## Additional notes

- This patch also makes the `prefs.ignore` list lowercase.
  This is to avoid converting it to lower case all the time.
- `prefs.colRename` is a hash. I saw that various preference options should also be a *dict* instead of a *list*.
- This code comes from SchrodingersGat#145
- I think is wrong, just fixing the flake8 error.
@set-soft
Copy link
Contributor Author

Hi @BillyPocketNC !

@set-soft @SchrodingersGat ,
What needs to change to get this merged?

My fault, I didn't notice @SchrodingersGat asked for conflict resolution.
I rebased the patch, fixed the conflicts and also fixed the flake8 error introduced by #145
Now the code passes flake8 tests and doesn't have any conflict.

@SchrodingersGat SchrodingersGat merged commit 183d0b1 into SchrodingersGat:master May 24, 2021
@SchrodingersGat
Copy link
Owner

Thanks :)

@BillyPocketNC
Copy link

Thanks this will be useful 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants