You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _sources/package-structure-code/pyproject-toml-python-package-metadata.md.txt
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -139,12 +139,12 @@ When you create your `pyproject.toml` file, there are numerous metadata fields t
139
139
140
140
[An overview of all of the project metadata elements can be found here.](https://packaging.python.org/en/latest/specifications/core-metadata/#project-url-multiple-use)
141
141
142
-
### Required fields for the [project] table
142
+
### Required fields for the `[project]` table
143
143
144
-
As mentioned above, your pyproject.toml file needs to have a **name** and **version** field in order to properly build your package:
144
+
As mentioned above, your `pyproject.toml` file needs to have a **`name`** and **`version`** field in order to properly build your package:
145
145
146
-
- Name: This is the name of your project provided as a string
147
-
- Version: This is the version of your project. If you are using a scm tool for versioning (using git tags to determine versions), then the version may be dynamic (more on that below).
146
+
- `name`: This is the name of your project provided as a string
147
+
- `version`: This is the version of your project. If you are using a SCM tool for versioning (using git tags to determine versions), then the version may be dynamic (more on that below).
148
148
149
149
### Optional fields to include in the `[project]` table
<p>When you create your <codeclass="docutils literal notranslate"><spanclass="pre">pyproject.toml</span></code> file, there are numerous metadata fields that you can use. Below we suggest specific fields to get you started that support publication on PyPI and users finding your package.</p>
583
583
<p><aclass="reference external" href="https://packaging.python.org/en/latest/specifications/core-metadata/#project-url-multiple-use">An overview of all of the project metadata elements can be found here.</a></p>
<h3>Required fields for the [project] table<aclass="headerlink" href="#required-fields-for-the-project-table" title="Link to this heading">#</a></h3>
586
-
<p>As mentioned above, your pyproject.toml file needs to have a <strong>name</strong> and <strong>version</strong> field in order to properly build your package:</p>
585
+
<h3>Required fields for the <codeclass="docutils literal notranslate"><spanclass="pre">[project]</span></code> table<aclass="headerlink" href="#required-fields-for-the-project-table" title="Link to this heading">#</a></h3>
586
+
<p>As mentioned above, your <codeclass="docutils literal notranslate"><spanclass="pre">pyproject.toml</span></code> file needs to have a <strong><codeclass="docutils literal notranslate"><spanclass="pre">name</span></code></strong> and <strong><codeclass="docutils literal notranslate"><spanclass="pre">version</span></code></strong> field in order to properly build your package:</p>
587
587
<ulclass="simple">
588
-
<li><p>Name: This is the name of your project provided as a string</p></li>
589
-
<li><p>Version: This is the version of your project. If you are using a scm tool for versioning (using git tags to determine versions), then the version may be dynamic (more on that below).</p></li>
588
+
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">name</span></code>: This is the name of your project provided as a string</p></li>
589
+
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">version</span></code>: This is the version of your project. If you are using a SCM tool for versioning (using git tags to determine versions), then the version may be dynamic (more on that below).</p></li>
@@ -814,7 +814,7 @@ <h2>Example pyproject.toml for building using setuptools<a class="headerlink" hr
814
814
</li>
815
815
<liclass="toc-h2 nav-item toc-entry"><aclass="reference internal nav-link" href="#benefits-of-using-a-pyproject-toml-file">Benefits of using a pyproject.toml file</a></li>
<liclass="toc-h3 nav-item toc-entry"><aclass="reference internal nav-link" href="#required-fields-for-the-project-table">Required fields for the [project] table</a></li>
817
+
<liclass="toc-h3 nav-item toc-entry"><aclass="reference internal nav-link" href="#required-fields-for-the-project-table">Required fields for the <codeclass="docutils literal notranslate"><spanclass="pre">[project]</span></code> table</a></li>
818
818
<liclass="toc-h3 nav-item toc-entry"><aclass="reference internal nav-link" href="#optional-fields-to-include-in-the-project-table">Optional fields to include in the <codeclass="docutils literal notranslate"><spanclass="pre">[project]</span></code> table</a></li>
819
819
<liclass="toc-h3 nav-item toc-entry"><aclass="reference internal nav-link" href="#advanced-options-in-the-pyproject-toml-file">Advanced options in the pyproject.toml file</a></li>
0 commit comments