In all csv exports that has a color column, add human understandable color name #2484

Closed
opened 2025-12-29 18:19:15 +01:00 by adam · 1 comment
Owner

Originally created by @Grokzen on GitHub (Mar 26, 2019).

Environment

  • Python version: 3.6.x
  • NetBox version: 2.5.x

Proposed Functionality

All models that has a color value/field and that has a csv export where color is included should be extended with a new column named color_name where the stored color string is matched against the already defined vairable COLOR_CHOICES. When exporting, check the string against the choices and if there is a match then use the defined name. If there is no match then either put empty or some default value like ---.

I can provide all needed code for this feature as we have this implemented in our fork.

Use Case

Humans do not understand the hex color codes and what it really translates to.

Database Changes

None

External Dependencies

None

Originally created by @Grokzen on GitHub (Mar 26, 2019). <!-- NOTE: This form is only for proposing specific new features or enhancements. If you have a general idea or question, please post to our mailing list instead of opening an issue: https://groups.google.com/forum/#!forum/netbox-discuss NOTE: Due to an excessive backlog of feature requests, we are not currently accepting any proposals which significantly extend NetBox's feature scope. Please describe the environment in which you are running NetBox. Be sure that you are running an unmodified instance of the latest stable release before submitting a bug report. --> ### Environment * Python version: 3.6.x <!-- Example: 3.5.4 --> * NetBox version: 2.5.x <!-- Example: 2.3.6 --> <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality All models that has a color value/field and that has a csv export where color is included should be extended with a new column named `color_name` where the stored color string is matched against the already defined vairable `COLOR_CHOICES`. When exporting, check the string against the choices and if there is a match then use the defined name. If there is no match then either put empty or some default value like `---`. I can provide all needed code for this feature as we have this implemented in our fork. <!-- Convey an example use case for your proposed feature. Write from the perspective of a NetBox user who would benefit from the proposed functionality and describe how. ---> ### Use Case Humans do not understand the hex color codes and what it really translates to. <!-- Note any changes to the database schema necessary to support the new feature. For example, does the proposal require adding a new model or field? (Not all new features require database changes.) ---> ### Database Changes None <!-- List any new dependencies on external libraries or services that this new feature would introduce. For example, does the proposal require the installation of a new Python package? (Not all new features introduce new dependencies.) --> ### External Dependencies None
adam closed this issue 2025-12-29 18:19:15 +01:00
Author
Owner

@jeremystretch commented on GitHub (Mar 26, 2019):

The built-in CSV export will always return the RGB value for a color. If you need the (arbitrary) human-friendly name presented in the UI, you can create a custom export template and call .get_color_display().

@jeremystretch commented on GitHub (Mar 26, 2019): The built-in CSV export will always return the RGB value for a color. If you need the (arbitrary) human-friendly name presented in the UI, you can create a custom export template and call `.get_color_display()`.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#2484