pyc-wheel 1.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pyc_wheel-1.3.0/.readthedocs.yml +15 -0
- pyc_wheel-1.3.0/CHANGES.rst +68 -0
- pyc_wheel-1.3.0/LICENSE +22 -0
- pyc_wheel-1.3.0/MANIFEST.in +18 -0
- pyc_wheel-1.3.0/PKG-INFO +248 -0
- pyc_wheel-1.3.0/README.rst +127 -0
- pyc_wheel-1.3.0/docs/CHANGES.rst +2 -0
- pyc_wheel-1.3.0/docs/README.rst +1 -0
- pyc_wheel-1.3.0/docs/_static/.keep +0 -0
- pyc_wheel-1.3.0/docs/_templates/.keep +0 -0
- pyc_wheel-1.3.0/docs/conf.py +115 -0
- pyc_wheel-1.3.0/docs/index.rst +19 -0
- pyc_wheel-1.3.0/pyproject.toml +282 -0
- pyc_wheel-1.3.0/setup.cfg +4 -0
- pyc_wheel-1.3.0/src/pyc_wheel/__about__.py +5 -0
- pyc_wheel-1.3.0/src/pyc_wheel/__init__.py +7 -0
- pyc_wheel-1.3.0/src/pyc_wheel/__main__.py +7 -0
- pyc_wheel-1.3.0/src/pyc_wheel/_pyc_wheel.py +264 -0
- pyc_wheel-1.3.0/src/pyc_wheel.egg-info/PKG-INFO +248 -0
- pyc_wheel-1.3.0/src/pyc_wheel.egg-info/SOURCES.txt +26 -0
- pyc_wheel-1.3.0/src/pyc_wheel.egg-info/dependency_links.txt +1 -0
- pyc_wheel-1.3.0/src/pyc_wheel.egg-info/requires.txt +17 -0
- pyc_wheel-1.3.0/src/pyc_wheel.egg-info/top_level.txt +1 -0
- pyc_wheel-1.3.0/src/pyc_wheel.egg-info/zip-safe +1 -0
- pyc_wheel-1.3.0/tests/__init__.py +10 -0
- pyc_wheel-1.3.0/tests/__main__.py +36 -0
- pyc_wheel-1.3.0/tests/data/.keep +0 -0
- pyc_wheel-1.3.0/tests/test_main.py +16 -0
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
Changelog
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
1.3.0 (2025-02-10)
|
|
5
|
+
------------------
|
|
6
|
+
- Add support for Python 3.10, 3.11, 3.12 and 3.13
|
|
7
|
+
- Drop support for Python 3.6, 3.7 and 3.8
|
|
8
|
+
- Add support for PyPy 3.9 and 3.10
|
|
9
|
+
- `Add --optimize argument to allow setting the optimization level
|
|
10
|
+
of the compiler. <https://github.com/karpierz/pyc_wheel/pull/14>`_
|
|
11
|
+
- `Wheel name should include Python tag.
|
|
12
|
+
<https://github.com/karpierz/pyc_wheel/pull/13>`_
|
|
13
|
+
- `Preserve the permissions bits.
|
|
14
|
+
<https://github.com/karpierz/pyc_wheel/pull/9>`_
|
|
15
|
+
- `Extend docs for --exclude and --help.
|
|
16
|
+
<https://github.com/karpierz/pyc_wheel/pull/7>`_
|
|
17
|
+
- Add --log argument to allow logging.
|
|
18
|
+
- 100% code linting.
|
|
19
|
+
- Copyright year update.
|
|
20
|
+
- Setup update (currently based on pyproject.toml).
|
|
21
|
+
- | Tox configuration has been moved to pyproject.toml
|
|
22
|
+
| and now based on tox >= 4.0
|
|
23
|
+
- Setup (dependencies) update.
|
|
24
|
+
|
|
25
|
+
1.2.7 (2021-10-14)
|
|
26
|
+
------------------
|
|
27
|
+
- Setup update.
|
|
28
|
+
|
|
29
|
+
1.2.6 (2021-07-20)
|
|
30
|
+
------------------
|
|
31
|
+
- Setup general update and improvement.
|
|
32
|
+
|
|
33
|
+
1.2.4 (2020-10-18)
|
|
34
|
+
------------------
|
|
35
|
+
- Drop support for Python 3.5.
|
|
36
|
+
- Fixed docs setup.
|
|
37
|
+
|
|
38
|
+
1.1.0 (2020-09-22)
|
|
39
|
+
------------------
|
|
40
|
+
- Add support for Python 3.9.
|
|
41
|
+
- `Fixed improper permission setting to read distribution.
|
|
42
|
+
<https://github.com/karpierz/pyc_wheel/pull/4>`_
|
|
43
|
+
- Setup general update and cleanup.
|
|
44
|
+
|
|
45
|
+
1.0.3 (2020-01-16)
|
|
46
|
+
------------------
|
|
47
|
+
- Added ReadTheDocs config file.
|
|
48
|
+
- Setup update.
|
|
49
|
+
|
|
50
|
+
1.0.2 (2019-12-03)
|
|
51
|
+
------------------
|
|
52
|
+
- Added the ability to exclude files from compilation.
|
|
53
|
+
- Added the ability to use wildcards.
|
|
54
|
+
|
|
55
|
+
1.0.1rc3 (2019-11-30)
|
|
56
|
+
---------------------
|
|
57
|
+
- A little fix for README.rst
|
|
58
|
+
|
|
59
|
+
1.0.1rc2 (2019-11-30)
|
|
60
|
+
---------------------
|
|
61
|
+
- | Creating a fork of Grant Patten's *pycwheel* package with a fixes,
|
|
62
|
+
| changes and improvements allowing to work with Python3 or higher.
|
|
63
|
+
|
|
64
|
+
Changes of the original *pycwheel*:
|
|
65
|
+
|
|
66
|
+
1.0.0 (Sep 25, 2016)
|
|
67
|
+
--------------------
|
|
68
|
+
- Initial commit.
|
pyc_wheel-1.3.0/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2016 Grant Patten <grant@gpatten.com>
|
|
4
|
+
Copyright (c) 2019-2025 Adam Karpierz <adam@karpierz.net>
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
8
|
+
in the Software without restriction, including without limitation the rights
|
|
9
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
11
|
+
furnished to do so, subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all
|
|
14
|
+
copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
22
|
+
SOFTWARE.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Copyright (c) 2019 Adam Karpierz
|
|
2
|
+
# SPDX-License-Identifier: MIT
|
|
3
|
+
|
|
4
|
+
include README.rst
|
|
5
|
+
include CHANGES.rst
|
|
6
|
+
include LICENSE
|
|
7
|
+
include pyproject.toml
|
|
8
|
+
include .readthedocs.yml
|
|
9
|
+
|
|
10
|
+
graft docs
|
|
11
|
+
|
|
12
|
+
graft src
|
|
13
|
+
|
|
14
|
+
graft tests
|
|
15
|
+
|
|
16
|
+
global-exclude \#* \#*/**
|
|
17
|
+
global-exclude .build .build/** .build.* .build.*/**
|
|
18
|
+
global-exclude *.py[cod] __pycache__
|
pyc_wheel-1.3.0/PKG-INFO
ADDED
|
@@ -0,0 +1,248 @@
|
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
|
+
Name: pyc_wheel
|
|
3
|
+
Version: 1.3.0
|
|
4
|
+
Summary: Compile all py files in a wheel to pyc files.
|
|
5
|
+
Author: Grant Patten, Adam Karpierz
|
|
6
|
+
Author-email: adam@karpierz.net
|
|
7
|
+
Maintainer: Adam Karpierz
|
|
8
|
+
Maintainer-email: adam@karpierz.net
|
|
9
|
+
License: MIT License ; https://opensource.org/license/mit
|
|
10
|
+
Project-URL: Homepage, https://pypi.org/project/pyc_wheel/
|
|
11
|
+
Project-URL: Documentation, https://pyc-wheel.readthedocs.io/
|
|
12
|
+
Project-URL: Download, https://pypi.org/project/pyc_wheel/
|
|
13
|
+
Project-URL: Source, https://github.com/karpierz/pyc_wheel
|
|
14
|
+
Project-URL: Issues, https://github.com/karpierz/pyc_wheel/issues
|
|
15
|
+
Keywords: pyc_wheel,pycwheel,wheel,pyc,compile
|
|
16
|
+
Platform: any
|
|
17
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
18
|
+
Classifier: Intended Audience :: Developers
|
|
19
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
20
|
+
Classifier: Operating System :: OS Independent
|
|
21
|
+
Classifier: Natural Language :: Polish
|
|
22
|
+
Classifier: Programming Language :: Python
|
|
23
|
+
Classifier: Programming Language :: Python :: 3
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
25
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
26
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
27
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
28
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
29
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
30
|
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
31
|
+
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
32
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
33
|
+
Classifier: Topic :: Utilities
|
|
34
|
+
Requires-Python: <4.0.0,>=3.9.0
|
|
35
|
+
Description-Content-Type: text/x-rst; charset=UTF-8
|
|
36
|
+
License-File: LICENSE
|
|
37
|
+
Requires-Dist: setuptools>=75.8.0
|
|
38
|
+
Requires-Dist: pkg-about>=1.2.8
|
|
39
|
+
Provides-Extra: doc
|
|
40
|
+
Requires-Dist: Sphinx>=7.4.7; extra == "doc"
|
|
41
|
+
Requires-Dist: sphinx-autodoc-typehints>=2.3.0; extra == "doc"
|
|
42
|
+
Requires-Dist: sphinx-toolbox>=3.8.1; extra == "doc"
|
|
43
|
+
Requires-Dist: sphinx-tabs>=3.4.5; extra == "doc"
|
|
44
|
+
Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
|
|
45
|
+
Requires-Dist: sphinxcontrib-spelling>=8.0.0; extra == "doc"
|
|
46
|
+
Requires-Dist: sphinx-lint>=1.0.0; extra == "doc"
|
|
47
|
+
Requires-Dist: restructuredtext-lint>=1.4.0; extra == "doc"
|
|
48
|
+
Requires-Dist: nbsphinx>=0.9.6; extra == "doc"
|
|
49
|
+
Provides-Extra: test
|
|
50
|
+
Requires-Dist: deepdiff>=8.1.1; extra == "test"
|
|
51
|
+
Requires-Dist: rich>=13.9.4; extra == "test"
|
|
52
|
+
|
|
53
|
+
pyc_wheel
|
|
54
|
+
=========
|
|
55
|
+
|
|
56
|
+
Compile all py files in a wheel to pyc files.
|
|
57
|
+
|
|
58
|
+
Overview
|
|
59
|
+
========
|
|
60
|
+
|
|
61
|
+
|package_bold| is a strict fork of Grant Patten's pycwheel_ package
|
|
62
|
+
with a fixes allowing to work with Python3 or higher and with a code
|
|
63
|
+
reformatting and some improvements.
|
|
64
|
+
|
|
65
|
+
`PyPI record`_.
|
|
66
|
+
|
|
67
|
+
`Documentation`_.
|
|
68
|
+
|
|
69
|
+
Usage
|
|
70
|
+
-----
|
|
71
|
+
|
|
72
|
+
Processing the wheel in place:
|
|
73
|
+
|
|
74
|
+
.. code-block:: bash
|
|
75
|
+
|
|
76
|
+
$ python -m pyc_wheel your_wheel-1.0.0-py3-none-any.whl
|
|
77
|
+
# Output: your_wheel-1.0.0-py3-none-any.whl
|
|
78
|
+
|
|
79
|
+
or with backup:
|
|
80
|
+
|
|
81
|
+
.. code-block:: bash
|
|
82
|
+
|
|
83
|
+
$ python -m pyc_wheel --with_backup your_wheel-1.0.0-py3-none-any.whl
|
|
84
|
+
# Output: your_wheel-1.0.0-py3-none-any.whl
|
|
85
|
+
# your_wheel-1.0.0-py3-none-any.whl.bak
|
|
86
|
+
|
|
87
|
+
or with quiet:
|
|
88
|
+
|
|
89
|
+
.. code-block:: bash
|
|
90
|
+
|
|
91
|
+
$ python -m pyc_wheel --quiet your_wheel-1.0.0-py3-none-any.whl
|
|
92
|
+
# Output: your_wheel-1.0.0-py3-none-any.whl
|
|
93
|
+
|
|
94
|
+
or skipping compilation for a file subset:
|
|
95
|
+
|
|
96
|
+
.. code-block:: bash
|
|
97
|
+
|
|
98
|
+
$ python -m pyc_wheel --exclude "some/regex" your_wheel-1.0.0-py3-none-any.whl
|
|
99
|
+
|
|
100
|
+
To check all available processing options:
|
|
101
|
+
|
|
102
|
+
.. code-block:: bash
|
|
103
|
+
|
|
104
|
+
$ python -m pyc_wheel --help
|
|
105
|
+
|
|
106
|
+
Installation
|
|
107
|
+
============
|
|
108
|
+
|
|
109
|
+
Prerequisites:
|
|
110
|
+
|
|
111
|
+
+ Python 3.9 or higher
|
|
112
|
+
|
|
113
|
+
* https://www.python.org/
|
|
114
|
+
|
|
115
|
+
+ pip and setuptools
|
|
116
|
+
|
|
117
|
+
* https://pypi.org/project/pip/
|
|
118
|
+
* https://pypi.org/project/setuptools/
|
|
119
|
+
|
|
120
|
+
To install run:
|
|
121
|
+
|
|
122
|
+
.. parsed-literal::
|
|
123
|
+
|
|
124
|
+
python -m pip install --upgrade |package|
|
|
125
|
+
|
|
126
|
+
Development
|
|
127
|
+
===========
|
|
128
|
+
|
|
129
|
+
Prerequisites:
|
|
130
|
+
|
|
131
|
+
+ Development is strictly based on *tox*. To install it run::
|
|
132
|
+
|
|
133
|
+
python -m pip install --upgrade tox
|
|
134
|
+
|
|
135
|
+
Visit `Development page`_.
|
|
136
|
+
|
|
137
|
+
Installation from sources:
|
|
138
|
+
|
|
139
|
+
clone the sources:
|
|
140
|
+
|
|
141
|
+
.. parsed-literal::
|
|
142
|
+
|
|
143
|
+
git clone |respository| |package|
|
|
144
|
+
|
|
145
|
+
and run:
|
|
146
|
+
|
|
147
|
+
.. parsed-literal::
|
|
148
|
+
|
|
149
|
+
python -m pip install ./|package|
|
|
150
|
+
|
|
151
|
+
or on development mode:
|
|
152
|
+
|
|
153
|
+
.. parsed-literal::
|
|
154
|
+
|
|
155
|
+
python -m pip install --editable ./|package|
|
|
156
|
+
|
|
157
|
+
License
|
|
158
|
+
=======
|
|
159
|
+
|
|
160
|
+
| |copyright|
|
|
161
|
+
| Copyright (c) 2016 Grant Patten
|
|
162
|
+
| Licensed under the MIT License
|
|
163
|
+
| https://opensource.org/license/mit
|
|
164
|
+
| Please refer to the accompanying LICENSE file.
|
|
165
|
+
|
|
166
|
+
Authors
|
|
167
|
+
=======
|
|
168
|
+
|
|
169
|
+
* Grant Patten <grant@gpatten.com>
|
|
170
|
+
* Adam Karpierz <adam@karpierz.net>
|
|
171
|
+
|
|
172
|
+
.. |package| replace:: pyc_wheel
|
|
173
|
+
.. |package_bold| replace:: **pyc_wheel**
|
|
174
|
+
.. |copyright| replace:: Copyright (c) 2019-2025 Adam Karpierz
|
|
175
|
+
.. |respository| replace:: https://github.com/karpierz/pyc_wheel.git
|
|
176
|
+
.. _Development page: https://github.com/karpierz/pyc_wheel
|
|
177
|
+
.. _PyPI record: https://pypi.org/project/pyc_wheel/
|
|
178
|
+
.. _Documentation: https://pyc-wheel.readthedocs.io/
|
|
179
|
+
.. _pycwheel: https://pypi.org/project/pycwheel/
|
|
180
|
+
|
|
181
|
+
Changelog
|
|
182
|
+
=========
|
|
183
|
+
|
|
184
|
+
1.3.0 (2025-02-10)
|
|
185
|
+
------------------
|
|
186
|
+
- Add support for Python 3.10, 3.11, 3.12 and 3.13
|
|
187
|
+
- Drop support for Python 3.6, 3.7 and 3.8
|
|
188
|
+
- Add support for PyPy 3.9 and 3.10
|
|
189
|
+
- `Add --optimize argument to allow setting the optimization level
|
|
190
|
+
of the compiler. <https://github.com/karpierz/pyc_wheel/pull/14>`_
|
|
191
|
+
- `Wheel name should include Python tag.
|
|
192
|
+
<https://github.com/karpierz/pyc_wheel/pull/13>`_
|
|
193
|
+
- `Preserve the permissions bits.
|
|
194
|
+
<https://github.com/karpierz/pyc_wheel/pull/9>`_
|
|
195
|
+
- `Extend docs for --exclude and --help.
|
|
196
|
+
<https://github.com/karpierz/pyc_wheel/pull/7>`_
|
|
197
|
+
- Add --log argument to allow logging.
|
|
198
|
+
- 100% code linting.
|
|
199
|
+
- Copyright year update.
|
|
200
|
+
- Setup update (currently based on pyproject.toml).
|
|
201
|
+
- | Tox configuration has been moved to pyproject.toml
|
|
202
|
+
| and now based on tox >= 4.0
|
|
203
|
+
- Setup (dependencies) update.
|
|
204
|
+
|
|
205
|
+
1.2.7 (2021-10-14)
|
|
206
|
+
------------------
|
|
207
|
+
- Setup update.
|
|
208
|
+
|
|
209
|
+
1.2.6 (2021-07-20)
|
|
210
|
+
------------------
|
|
211
|
+
- Setup general update and improvement.
|
|
212
|
+
|
|
213
|
+
1.2.4 (2020-10-18)
|
|
214
|
+
------------------
|
|
215
|
+
- Drop support for Python 3.5.
|
|
216
|
+
- Fixed docs setup.
|
|
217
|
+
|
|
218
|
+
1.1.0 (2020-09-22)
|
|
219
|
+
------------------
|
|
220
|
+
- Add support for Python 3.9.
|
|
221
|
+
- `Fixed improper permission setting to read distribution.
|
|
222
|
+
<https://github.com/karpierz/pyc_wheel/pull/4>`_
|
|
223
|
+
- Setup general update and cleanup.
|
|
224
|
+
|
|
225
|
+
1.0.3 (2020-01-16)
|
|
226
|
+
------------------
|
|
227
|
+
- Added ReadTheDocs config file.
|
|
228
|
+
- Setup update.
|
|
229
|
+
|
|
230
|
+
1.0.2 (2019-12-03)
|
|
231
|
+
------------------
|
|
232
|
+
- Added the ability to exclude files from compilation.
|
|
233
|
+
- Added the ability to use wildcards.
|
|
234
|
+
|
|
235
|
+
1.0.1rc3 (2019-11-30)
|
|
236
|
+
---------------------
|
|
237
|
+
- A little fix for README.rst
|
|
238
|
+
|
|
239
|
+
1.0.1rc2 (2019-11-30)
|
|
240
|
+
---------------------
|
|
241
|
+
- | Creating a fork of Grant Patten's *pycwheel* package with a fixes,
|
|
242
|
+
| changes and improvements allowing to work with Python3 or higher.
|
|
243
|
+
|
|
244
|
+
Changes of the original *pycwheel*:
|
|
245
|
+
|
|
246
|
+
1.0.0 (Sep 25, 2016)
|
|
247
|
+
--------------------
|
|
248
|
+
- Initial commit.
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
pyc_wheel
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
Compile all py files in a wheel to pyc files.
|
|
5
|
+
|
|
6
|
+
Overview
|
|
7
|
+
========
|
|
8
|
+
|
|
9
|
+
|package_bold| is a strict fork of Grant Patten's pycwheel_ package
|
|
10
|
+
with a fixes allowing to work with Python3 or higher and with a code
|
|
11
|
+
reformatting and some improvements.
|
|
12
|
+
|
|
13
|
+
`PyPI record`_.
|
|
14
|
+
|
|
15
|
+
`Documentation`_.
|
|
16
|
+
|
|
17
|
+
Usage
|
|
18
|
+
-----
|
|
19
|
+
|
|
20
|
+
Processing the wheel in place:
|
|
21
|
+
|
|
22
|
+
.. code-block:: bash
|
|
23
|
+
|
|
24
|
+
$ python -m pyc_wheel your_wheel-1.0.0-py3-none-any.whl
|
|
25
|
+
# Output: your_wheel-1.0.0-py3-none-any.whl
|
|
26
|
+
|
|
27
|
+
or with backup:
|
|
28
|
+
|
|
29
|
+
.. code-block:: bash
|
|
30
|
+
|
|
31
|
+
$ python -m pyc_wheel --with_backup your_wheel-1.0.0-py3-none-any.whl
|
|
32
|
+
# Output: your_wheel-1.0.0-py3-none-any.whl
|
|
33
|
+
# your_wheel-1.0.0-py3-none-any.whl.bak
|
|
34
|
+
|
|
35
|
+
or with quiet:
|
|
36
|
+
|
|
37
|
+
.. code-block:: bash
|
|
38
|
+
|
|
39
|
+
$ python -m pyc_wheel --quiet your_wheel-1.0.0-py3-none-any.whl
|
|
40
|
+
# Output: your_wheel-1.0.0-py3-none-any.whl
|
|
41
|
+
|
|
42
|
+
or skipping compilation for a file subset:
|
|
43
|
+
|
|
44
|
+
.. code-block:: bash
|
|
45
|
+
|
|
46
|
+
$ python -m pyc_wheel --exclude "some/regex" your_wheel-1.0.0-py3-none-any.whl
|
|
47
|
+
|
|
48
|
+
To check all available processing options:
|
|
49
|
+
|
|
50
|
+
.. code-block:: bash
|
|
51
|
+
|
|
52
|
+
$ python -m pyc_wheel --help
|
|
53
|
+
|
|
54
|
+
Installation
|
|
55
|
+
============
|
|
56
|
+
|
|
57
|
+
Prerequisites:
|
|
58
|
+
|
|
59
|
+
+ Python 3.9 or higher
|
|
60
|
+
|
|
61
|
+
* https://www.python.org/
|
|
62
|
+
|
|
63
|
+
+ pip and setuptools
|
|
64
|
+
|
|
65
|
+
* https://pypi.org/project/pip/
|
|
66
|
+
* https://pypi.org/project/setuptools/
|
|
67
|
+
|
|
68
|
+
To install run:
|
|
69
|
+
|
|
70
|
+
.. parsed-literal::
|
|
71
|
+
|
|
72
|
+
python -m pip install --upgrade |package|
|
|
73
|
+
|
|
74
|
+
Development
|
|
75
|
+
===========
|
|
76
|
+
|
|
77
|
+
Prerequisites:
|
|
78
|
+
|
|
79
|
+
+ Development is strictly based on *tox*. To install it run::
|
|
80
|
+
|
|
81
|
+
python -m pip install --upgrade tox
|
|
82
|
+
|
|
83
|
+
Visit `Development page`_.
|
|
84
|
+
|
|
85
|
+
Installation from sources:
|
|
86
|
+
|
|
87
|
+
clone the sources:
|
|
88
|
+
|
|
89
|
+
.. parsed-literal::
|
|
90
|
+
|
|
91
|
+
git clone |respository| |package|
|
|
92
|
+
|
|
93
|
+
and run:
|
|
94
|
+
|
|
95
|
+
.. parsed-literal::
|
|
96
|
+
|
|
97
|
+
python -m pip install ./|package|
|
|
98
|
+
|
|
99
|
+
or on development mode:
|
|
100
|
+
|
|
101
|
+
.. parsed-literal::
|
|
102
|
+
|
|
103
|
+
python -m pip install --editable ./|package|
|
|
104
|
+
|
|
105
|
+
License
|
|
106
|
+
=======
|
|
107
|
+
|
|
108
|
+
| |copyright|
|
|
109
|
+
| Copyright (c) 2016 Grant Patten
|
|
110
|
+
| Licensed under the MIT License
|
|
111
|
+
| https://opensource.org/license/mit
|
|
112
|
+
| Please refer to the accompanying LICENSE file.
|
|
113
|
+
|
|
114
|
+
Authors
|
|
115
|
+
=======
|
|
116
|
+
|
|
117
|
+
* Grant Patten <grant@gpatten.com>
|
|
118
|
+
* Adam Karpierz <adam@karpierz.net>
|
|
119
|
+
|
|
120
|
+
.. |package| replace:: pyc_wheel
|
|
121
|
+
.. |package_bold| replace:: **pyc_wheel**
|
|
122
|
+
.. |copyright| replace:: Copyright (c) 2019-2025 Adam Karpierz
|
|
123
|
+
.. |respository| replace:: https://github.com/karpierz/pyc_wheel.git
|
|
124
|
+
.. _Development page: https://github.com/karpierz/pyc_wheel
|
|
125
|
+
.. _PyPI record: https://pypi.org/project/pyc_wheel/
|
|
126
|
+
.. _Documentation: https://pyc-wheel.readthedocs.io/
|
|
127
|
+
.. _pycwheel: https://pypi.org/project/pycwheel/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.. include:: ../README.rst
|
|
File without changes
|
|
File without changes
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# Configuration file for the Sphinx documentation builder.
|
|
2
|
+
#
|
|
3
|
+
# This file only contains a selection of the most common options. For a full
|
|
4
|
+
# list see the documentation:
|
|
5
|
+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
6
|
+
|
|
7
|
+
__import__("pkg_about").about_from_setup()
|
|
8
|
+
|
|
9
|
+
def setup(app):
|
|
10
|
+
pass
|
|
11
|
+
|
|
12
|
+
# -- Path setup --------------------------------------------------------------
|
|
13
|
+
|
|
14
|
+
# If extensions (or modules to document with autodoc) are in another directory,
|
|
15
|
+
# add these directories to sys.path here. If the directory is relative to the
|
|
16
|
+
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
17
|
+
#
|
|
18
|
+
# import os
|
|
19
|
+
# import sys
|
|
20
|
+
# sys.path.insert(0, os.path.abspath('.'))
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
# -- Project information -----------------------------------------------------
|
|
24
|
+
|
|
25
|
+
project = about.__title__
|
|
26
|
+
copyright = about.__copyright__
|
|
27
|
+
author = about.__author__
|
|
28
|
+
|
|
29
|
+
# The full version, including alpha/beta/rc tags
|
|
30
|
+
release = about.__version__
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
# -- General configuration ---------------------------------------------------
|
|
34
|
+
|
|
35
|
+
# If your documentation needs a minimal Sphinx version, state it here.
|
|
36
|
+
#
|
|
37
|
+
needs_sphinx = '7.4.7'
|
|
38
|
+
|
|
39
|
+
# Add any Sphinx extension module names here, as strings. They can be
|
|
40
|
+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
41
|
+
# ones.
|
|
42
|
+
extensions = [
|
|
43
|
+
'sphinx.ext.autodoc',
|
|
44
|
+
'sphinx.ext.autosummary',
|
|
45
|
+
'sphinx.ext.doctest',
|
|
46
|
+
'sphinx.ext.intersphinx',
|
|
47
|
+
#'sphinx.ext.todo',
|
|
48
|
+
#'sphinx.ext.coverage',
|
|
49
|
+
'sphinx.ext.ifconfig',
|
|
50
|
+
'sphinx.ext.napoleon',
|
|
51
|
+
'sphinx_autodoc_typehints',
|
|
52
|
+
#'sphinx_toolbox',
|
|
53
|
+
'sphinx_tabs.tabs',
|
|
54
|
+
'sphinx_copybutton',
|
|
55
|
+
'sphinxcontrib.spelling',
|
|
56
|
+
'nbsphinx',
|
|
57
|
+
]
|
|
58
|
+
|
|
59
|
+
# Needed for e.g. linkcheck builder
|
|
60
|
+
tls_verify = False
|
|
61
|
+
|
|
62
|
+
# Add any paths that contain templates here, relative to this directory.
|
|
63
|
+
templates_path = ['_templates']
|
|
64
|
+
|
|
65
|
+
# The encoding of source files.
|
|
66
|
+
#
|
|
67
|
+
source_encoding = 'utf-8'
|
|
68
|
+
|
|
69
|
+
# The master toctree document.
|
|
70
|
+
master_doc = 'index'
|
|
71
|
+
|
|
72
|
+
# List of patterns, relative to source directory, that match files and
|
|
73
|
+
# directories to ignore when looking for source files.
|
|
74
|
+
# This pattern also affects html_static_path and html_extra_path.
|
|
75
|
+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
76
|
+
|
|
77
|
+
# The name of the Pygments (syntax highlighting) style to use.
|
|
78
|
+
pygments_style = 'sphinx'
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
# -- Options for HTML output -------------------------------------------------
|
|
82
|
+
|
|
83
|
+
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
84
|
+
# a list of builtin themes.
|
|
85
|
+
#
|
|
86
|
+
html_theme = 'bizstyle' # 'alabaster'
|
|
87
|
+
|
|
88
|
+
# Add any paths that contain custom static files (such as style sheets) here,
|
|
89
|
+
# relative to this directory. They are copied after the builtin static files,
|
|
90
|
+
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
91
|
+
html_static_path = ['_static']
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
# -- Extension configuration -------------------------------------------------
|
|
95
|
+
|
|
96
|
+
# -- Options for autodoc extension -------------------------------------------
|
|
97
|
+
|
|
98
|
+
autoclass_content = 'both'
|
|
99
|
+
autodoc_member_order = 'bysource'
|
|
100
|
+
|
|
101
|
+
# -- Options for apidoc extension --------------------------------------------
|
|
102
|
+
|
|
103
|
+
apidoc_separate_modules = True
|
|
104
|
+
apidoc_module_first = True
|
|
105
|
+
apidoc_output_dir = 'api'
|
|
106
|
+
|
|
107
|
+
# -- Options for intersphinx extension ---------------------------------------
|
|
108
|
+
|
|
109
|
+
# Example configuration for intersphinx: refer to the Python standard library.
|
|
110
|
+
# intersphinx_mapping = {'https://docs.python.org/': None}
|
|
111
|
+
|
|
112
|
+
# -- Options for todo extension ----------------------------------------------
|
|
113
|
+
|
|
114
|
+
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
115
|
+
todo_include_todos = False
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
pyc_wheel documentation
|
|
2
|
+
=======================
|
|
3
|
+
|
|
4
|
+
.. _readme:
|
|
5
|
+
.. include:: README.rst
|
|
6
|
+
|
|
7
|
+
Contents
|
|
8
|
+
========
|
|
9
|
+
|
|
10
|
+
.. toctree::
|
|
11
|
+
:maxdepth: 2
|
|
12
|
+
|
|
13
|
+
CHANGES.rst
|
|
14
|
+
|
|
15
|
+
Indices and tables
|
|
16
|
+
==================
|
|
17
|
+
|
|
18
|
+
* :ref:`genindex`
|
|
19
|
+
* :ref:`search`
|