[PR #2881] [MERGED] Clarify use of "runreport" CLI #12455

New Issue

adam · 2025-12-29T22:21:40+01:00

adam commented

2025-12-29 22:21:40 +01:00

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/2881
Author: @candlerb
Created: 2/13/2019
Status: ✅ Merged
Merged: 2/20/2019
Merged by: @jeremystretch

Base: develop ← Head: candlerb/doc-reports

📝 Commits (1)

8d86e97 Clarify use of "runreport" CLI

📊 Changes

1 file changed (+1 additions, -1 deletions)

View changed files

📝 docs/additional-features/reports.md (+1 -1)

📄 Description

Fixes:

Minor documentation enhancement about how correctly to invoke runreport.

The behaviour of runreport is confusing if you don't know exactly what to do. Suppose you create reports/foo-bar.py containing class FooBar. The following commands all just return [hh:mm:ss] Finished without any error - but nothing is executed, and there is no indication why not.

python3 manage.py runreport FooBar
python3 manage.py runreport foo-bar.py
python3 manage.py runreport reports/foo-bar.py

It took me a while to work out that the correct command is:

python3 manage.py runreport foo-bar

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/2881 **Author:** [@candlerb](https://github.com/candlerb) **Created:** 2/13/2019 **Status:** ✅ Merged **Merged:** 2/20/2019 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `develop` ← **Head:** `candlerb/doc-reports` --- ### 📝 Commits (1) - [`8d86e97`](https://github.com/netbox-community/netbox/commit/8d86e97247a9971057a96dd6b74cae7b194c4653) Clarify use of "runreport" CLI ### 📊 Changes **1 file changed** (+1 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/additional-features/reports.md` (+1 -1) </details> ### 📄 Description ### Fixes: Minor documentation enhancement about how correctly to invoke `runreport`. The behaviour of runreport is confusing if you don't know exactly what to do. Suppose you create `reports/foo-bar.py` containing `class FooBar`. The following commands all just return `[hh:mm:ss] Finished` without any error - but nothing is executed, and there is no indication why not. ``` python3 manage.py runreport FooBar python3 manage.py runreport foo-bar.py python3 manage.py runreport reports/foo-bar.py ``` It took me a while to work out that the correct command is: ``` python3 manage.py runreport foo-bar ``` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

adam added the pull-request label 2025-12-29 22:21:40 +01:00

adam closed this issue

2025-12-29 22:21:40 +01:00

adam referenced this issue

2025-12-29 23:21:52 +01:00

[PR #12455] [MERGED] Adds module status to module bay table #13978

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#12455