[PR #19643] [MERGED] Closes #19535 - Add Project Stanza to pyproject toml #15690

Closed
opened 2025-12-30 00:23:25 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/19643
Author: @pheus
Created: 6/4/2025
Status: Merged
Merged: 6/4/2025
Merged by: @jnovinger

Base: mainHead: 19535-add-project-stanza-to-pyproject-toml


📝 Commits (6)

  • 0f3a7d2 feat(project): Add project metadata to pyproject.toml
  • 6fda6a5 docs(release): Add checklist item for Python versions in pyproject.toml
  • 77108d1 docs(release): Update checklist to include pyproject.toml versioning
  • fc7e1cd feat(project): Update pyproject.toml for best practices
  • cead6ca fix(project): Update repository URL key in pyproject.toml
  • b84599e fix(project): Specify Python 3 :: Only in classifiers

📊 Changes

2 files changed (+36 additions, -1 deletions)

View changed files

📝 docs/development/release-checklist.md (+2 -1)
📝 pyproject.toml (+34 -0)

📄 Description

Fixes: #19535 - Update pyproject.toml with a [project] stanza

This PR adds a [project] section to pyproject.toml to improve compatibility with tools like uv, which rely on PEP 621-compliant metadata.

The section includes basic project metadata such as name, version, description, license, authors, and relevant URLs. This is primarily intended to help users who wish to manage their virtual environments using uv, which otherwise fails without a [project] table.

The version field is currently maintained manually to match the main NetBox version. Dynamic versioning was considered but isn't suitable here, as we're not building NetBox as a Python package.

Let me know if any adjustments are needed!


🔄 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/19643 **Author:** [@pheus](https://github.com/pheus) **Created:** 6/4/2025 **Status:** ✅ Merged **Merged:** 6/4/2025 **Merged by:** [@jnovinger](https://github.com/jnovinger) **Base:** `main` ← **Head:** `19535-add-project-stanza-to-pyproject-toml` --- ### 📝 Commits (6) - [`0f3a7d2`](https://github.com/netbox-community/netbox/commit/0f3a7d2366fc5f1d471c2fd0ae8509bf5cb6d1e9) feat(project): Add project metadata to pyproject.toml - [`6fda6a5`](https://github.com/netbox-community/netbox/commit/6fda6a5184deb09da6311fa05a698bde37c2dfaa) docs(release): Add checklist item for Python versions in pyproject.toml - [`77108d1`](https://github.com/netbox-community/netbox/commit/77108d1c4238652c5789d8002a1208d3cd616093) docs(release): Update checklist to include pyproject.toml versioning - [`fc7e1cd`](https://github.com/netbox-community/netbox/commit/fc7e1cd9a6a49e18ff960c3a63d3f28adf46d47c) feat(project): Update pyproject.toml for best practices - [`cead6ca`](https://github.com/netbox-community/netbox/commit/cead6cad37856a4419ff4ba1c8de1f6dd1aee6a2) fix(project): Update repository URL key in pyproject.toml - [`b84599e`](https://github.com/netbox-community/netbox/commit/b84599e45b504b0364e2787bee818aae9bc86e43) fix(project): Specify Python 3 :: Only in classifiers ### 📊 Changes **2 files changed** (+36 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/development/release-checklist.md` (+2 -1) 📝 `pyproject.toml` (+34 -0) </details> ### 📄 Description <!-- Thank you for your interest in contributing to NetBox! Please note that our contribution policy requires that a feature request or bug report be approved and assigned prior to opening a pull request. This helps avoid waste time and effort on a proposed change that we might not be able to accept. IF YOUR PULL REQUEST DOES NOT REFERENCE AN ISSUE WHICH HAS BEEN ASSIGNED TO YOU, IT WILL BE CLOSED AUTOMATICALLY. Please specify your assigned issue number on the line below. --> ### Fixes: #19535 - Update pyproject.toml with a [project] stanza This PR adds a `[project]` section to `pyproject.toml` to improve compatibility with tools like [`uv`](https://github.com/astral-sh/uv), which rely on PEP 621-compliant metadata. The section includes basic project metadata such as name, version, description, license, authors, and relevant URLs. This is primarily intended to help users who wish to manage their virtual environments using `uv`, which otherwise fails without a `[project]` table. The version field is currently maintained manually to match the main NetBox version. Dynamic versioning was considered but isn't suitable here, as we're not building NetBox as a Python package. Let me know if any adjustments are needed! --- <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-30 00:23:25 +01:00
adam closed this issue 2025-12-30 00:23:25 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#15690