Skip to content
This repository was archived by the owner on Oct 24, 2025. It is now read-only.

Commit 91b7b13

Browse files
committed
Moved requirements file from 'dist' to 'build' and renamed the files accordingly.
1 parent 3fee3c1 commit 91b7b13

12 files changed

Lines changed: 37 additions & 26 deletions

.github/workflows/Pipeline.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ jobs:
229229
- name: 🔧 Install dependencies for packaging and release
230230
run: |
231231
python -m pip install --upgrade pip
232-
pip install wheel
232+
pip install -r build/requirements.package.txt
233233
234234
- name: 🔨 Build Python package (source distribution)
235235
run: |
@@ -278,7 +278,7 @@ jobs:
278278
- name: ⚙ Install dependencies for packaging and release
279279
run: |
280280
python -m pip install --upgrade pip
281-
pip install wheel twine
281+
pip install -r build/requirements.publish.txt
282282
283283
- name: ⤴ Release Python package to PyPI
284284
env:

.gitignore

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,13 @@ __pycache__/
88
coverage.xml
99

1010
# setuptools
11-
/build
12-
/dist
11+
/build/**/*.*
12+
/dist/**/*.*
1313
/*.egg-info
1414

15+
# Dependencies
16+
!requirements*.txt
17+
1518
# Sphinx
1619
doc/_build/
1720
doc/pyTooling.TerminalUI/**/*.*

.idea/modules.xml

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/pyTooling.TerminalUI.iml

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/vcs.xml

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

build/requirements.package.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
pyTooling.Packaging>=0.2.1
2+
3+
wheel

build/requirements.publish.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
wheel
2+
twine

doc/Dependencies.rst

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Dependencies
1010
.. |img-TerminalUI-req-status| image:: https://img.shields.io/requires/github/pyTooling/pyTooling.TerminalUI
1111
:alt: Requires.io
1212
:height: 22
13-
:target: https://requires.io/github/pyTooling/pyTooling.TerminalUI/requirements/?branch=master
13+
:target: https://requires.io/github/pyTooling/pyTooling.TerminalUI/requirements/?branch=main
1414

1515
+------------------------------------------+------------------------------------------+
1616
| `Libraries.io <https://libraries.io/>`_ | `Requires.io <https://requires.io/>`_ |
@@ -25,8 +25,8 @@ pyTooling.TerminalUI Package (Mandatory)
2525

2626
.. rubric:: Manually Installing Package Requirements
2727

28-
Use the :file:`requirements.txt` file to install all dependencies via ``pip3``
29-
or install the package directly from PyPI (see :ref:`installation`).
28+
Use the :file:`requirements.txt` file to install all dependencies via ``pip3`` or install the package directly from
29+
PyPI (see :ref:`installation`).
3030

3131
.. code-block:: shell
3232
@@ -40,25 +40,24 @@ or install the package directly from PyPI (see :ref:`installation`).
4040
+==========================================================+=============+===========================================================================================+=================================================================================================================================+
4141
| `colorama <https://GitHub.com/tartley/colorama>`__ | ≥0.4.4 | `BSD-3-Clause <https://GitHub.com/tartley/colorama/blob/master/LICENSE.txt>`__ | None |
4242
+----------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
43-
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥1.4.4 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/master/LICENSE.txt>`__ | *None* |
43+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥1.4.6 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__ | *None* |
4444
+----------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
4545

4646

4747

4848
.. _dependency-testing:
4949

50-
Unit Testing / Coverage (Optional)
51-
**********************************
50+
Unit Testing / Coverage / Type Checking (Optional)
51+
**************************************************
5252

53-
Additional Python packages needed for testing and code coverage collection.
54-
These packages are only needed for developers or on a CI server, thus
55-
sub-dependencies are not evaluated further.
53+
Additional Python packages needed for testing, code coverage collection and static type checking. These packages are
54+
only needed for developers or on a CI server, thus sub-dependencies are not evaluated further.
5655

5756

5857
.. rubric:: Manually Installing Test Requirements
5958

60-
Use the :file:`tests/requirements.txt` file to install all dependencies via
61-
``pip3``. The file will recursively install the mandatory dependencies too.
59+
Use the :file:`tests/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively install
60+
the mandatory dependencies too.
6261

6362
.. code-block:: shell
6463
@@ -87,15 +86,14 @@ Use the :file:`tests/requirements.txt` file to install all dependencies via
8786
Sphinx Documentation (Optional)
8887
*******************************
8988

90-
Additional Python packages needed for documentation generation. These packages
91-
are only needed for developers or on a CI server, thus sub-dependencies are not
92-
evaluated further.
89+
Additional Python packages needed for documentation generation. These packages are only needed for developers or on a
90+
CI server, thus sub-dependencies are not evaluated further.
9391

9492

9593
.. rubric:: Manually Installing Documentation Requirements
9694

97-
Use the :file:`doc/requirements.txt` file to install all dependencies via
98-
``pip3``. The file will recursively install the mandatory dependencies too.
95+
Use the :file:`doc/requirements.txt` file to install all dependencies via ``pip3``. The file will recursively install
96+
the mandatory dependencies too.
9997

10098
.. code-block:: shell
10199

doc/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,8 +233,8 @@
233233
extlinks = {
234234
'issue': ('https://GitHub.com/pyTooling/pyTooling.TerminalUI/issues/%s', 'issue #'),
235235
'pull': ('https://GitHub.com/pyTooling/pyTooling.TerminalUI/pull/%s', 'pull request #'),
236-
'src': ('https://GitHub.com/pyTooling/pyTooling.TerminalUI/blob/master/pyTooling/%s?ts=2', None),
237-
# 'test': ('https://GitHub.com/pyTooling/pyTooling/blob/master/test/%s?ts=2', None)
236+
'src': ('https://GitHub.com/pyTooling/pyTooling.TerminalUI/blob/main/pyTooling/%s?ts=2', None),
237+
# 'test': ('https://GitHub.com/pyTooling/pyTooling.TerminalUI/blob/main/test/%s?ts=2', None)
238238
}
239239

240240

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
.. |img-TerminalUI-req-status| image:: https://img.shields.io/requires/github/pyTooling/pyTooling.TerminalUI
5959
:alt: Requires.io
6060
:height: 22
61-
:target: https://requires.io/github/pyTooling/pyTooling.TerminalUI/requirements/?branch=master
61+
:target: https://requires.io/github/pyTooling/pyTooling.TerminalUI/requirements/?branch=main
6262
.. |img-TerminalUI-doclicense| image:: https://img.shields.io/badge/doc%20license-CC--BY%204.0-green?logo=readthedocs
6363
:alt: Documentation License
6464
:height: 22

0 commit comments

Comments
 (0)