1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
#####
whey
#####
.. start short_desc
**A simple Python wheel builder for simple projects.**
.. end short_desc
``whey``:
* supports `PEP 621 <https://www.python.org/dev/peps/pep-0621/>`_ metadata.
* can be used as a `PEP 517 <https://www.python.org/dev/peps/pep-0517/>`_ build backend.
* creates `PEP 427 <https://www.python.org/dev/peps/pep-0427/>`_ `wheels <https://realpython.com/python-wheels/>`_.
* handles type hint files
(`py.typed <https://www.python.org/dev/peps/pep-0561/>`_ and ``*.pyi`` stubs).
* is distributed under the `MIT License <https://choosealicense.com/licenses/mit/>`_.
* `is the liquid remaining after milk has been curdled and strained <https://en.wikipedia.org/wiki/Whey>`_.
It is a byproduct of the manufacture of cheese and has several commercial uses.
See `the documentation`_ for configuration_ and usage_ information.
.. _the documentation: https://whey.readthedocs.io/en/latest/
.. _configuration: https://whey.readthedocs.io/en/latest/configuration.html
.. _usage: https://whey.readthedocs.io/en/latest/configuration.html
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/whey/latest?logo=read-the-docs
:target: https://whey.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/repo-helper/whey/workflows/Docs%20Check/badge.svg
:target: https://github.com/repo-helper/whey/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/repo-helper/whey/workflows/Linux/badge.svg
:target: https://github.com/repo-helper/whey/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/repo-helper/whey/workflows/Windows/badge.svg
:target: https://github.com/repo-helper/whey/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/repo-helper/whey/workflows/macOS/badge.svg
:target: https://github.com/repo-helper/whey/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/repo-helper/whey/workflows/Flake8/badge.svg
:target: https://github.com/repo-helper/whey/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/repo-helper/whey/workflows/mypy/badge.svg
:target: https://github.com/repo-helper/whey/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/repo-helper/whey/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/repo-helper/whey/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/repo-helper/whey/master?logo=coveralls
:target: https://coveralls.io/github/repo-helper/whey?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/repo-helper/whey?logo=codefactor
:target: https://www.codefactor.io/repository/github/repo-helper/whey
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/whey
:target: https://pypi.org/project/whey/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/whey?logo=python&logoColor=white
:target: https://pypi.org/project/whey/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/whey
:target: https://pypi.org/project/whey/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/whey
:target: https://pypi.org/project/whey/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/conda-forge/whey?logo=anaconda
:target: https://anaconda.org/conda-forge/whey
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/conda-forge/whey?label=conda%7Cplatform
:target: https://anaconda.org/conda-forge/whey
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/repo-helper/whey
:target: https://github.com/repo-helper/whey/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/repo-helper/whey
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/repo-helper/whey/v0.1.1
:target: https://github.com/repo-helper/whey/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/repo-helper/whey
:target: https://github.com/repo-helper/whey/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/whey
:target: https://pypi.org/project/whey/
:alt: PyPI - Downloads
.. end shields
Installation
--------------
.. start installation
``whey`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install whey
To install with ``conda``:
.. code-block:: bash
$ conda install -c conda-forge whey
.. end installation
``whey`` also has an optional README validation feature, which checks the README will render correctly on PyPI.
This requires that the ``readme`` extra is installed:
.. code-block:: bash
$ python -m pip install whey[readme]
and in ``pyproject.toml``:
.. code-block:: TOML
[build-system]
requires = [ "whey[readme]",]
build-backend = "whey"
|
