Skip to content

Commit 5c1e131

Browse files
committed
setup.py -> pyproject.toml, version bump
1 parent 5240f7b commit 5c1e131

5 files changed

Lines changed: 59 additions & 56 deletions

File tree

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
python-version: ${{ matrix.python-version }}
1818
- name: Install package and pytest
1919
run: |
20-
python setup.py install
20+
pip install -U .
2121
pip install pytest
2222
- name: Run tests
2323
run: |

README.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,11 @@ command will install the plugin with its dependencies::
170170

171171
$ conda install -c conda-forge flake8-rst-docstrings
172172

173+
Developers may install the plugin from the git repository with optional
174+
dependencies::
175+
176+
$ pip install -e .[develop]
177+
173178
The new validator should be automatically included when using ``flake8`` which
174179
may now report additional validation codes starting with ``RST`` (as defined
175180
above). For example::
@@ -245,6 +250,7 @@ Version History
245250
======= ========== ===========================================================
246251
Version Released Changes
247252
------- ---------- -----------------------------------------------------------
253+
v0.3.0 2022-11-16 - Replaced ``setup.py`` with ``pyproject.toml``.
248254
v0.2.7 2022-07-15 - Fix where function signature occurred in docstring body.
249255
v0.2.6 2022-06-07 - Configuration option to define additional substitutions
250256
(e.g. from Sphinx) for ``RST305`` (contribution from
@@ -303,7 +309,7 @@ This plugin is on GitHub at https://github.com/peterjc/flake8-rst-docstrings
303309
To make a new release once tested locally and on TravisCI::
304310

305311
$ git tag vX.Y.Z
306-
$ python setup.py sdist --formats=gztar && python setup.py bdist_wheel
312+
$ python -m build
307313
$ git push origin master --tags
308314
$ twine upload dist/flake8?rst?docstrings-X.Y.Z*
309315

flake8_rst_docstrings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
re.VERBOSE,
2626
)
2727

28-
__version__ = "0.2.7"
28+
__version__ = "0.3.0"
2929

3030

3131
rst_prefix = "RST"

pyproject.toml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
[build-system]
2+
requires = ['pip>=20.3', 'setuptools>=61', 'wheel']
3+
build-backend = 'setuptools.build_meta'
4+
5+
[project]
6+
name = 'flake8-rst-docstrings'
7+
description = 'Python docstring reStructuredText (RST) validator for flake8'
8+
keywords = ['strings', 'formatting', 'style', 'docstrings', 'reStructuredText']
9+
license = {text = 'MIT'}
10+
readme = 'README.rst'
11+
authors = [
12+
{name = 'Peter J. A. Cock'}
13+
]
14+
maintainers = [
15+
{name = 'Peter J. A. Cock', email = 'p.j.a.cock@googlemail.com'}
16+
]
17+
classifiers = [
18+
'Development Status :: 4 - Beta',
19+
'Intended Audience :: Developers',
20+
'Framework :: Flake8',
21+
'License :: OSI Approved :: MIT License',
22+
'Operating System :: OS Independent',
23+
'Topic :: Software Development :: Libraries :: Python Modules',
24+
'Topic :: Software Development :: Quality Assurance',
25+
'Programming Language :: Python',
26+
'Programming Language :: Python :: 3',
27+
'Programming Language :: Python :: 3 :: Only'
28+
]
29+
requires-python = '>=3.7'
30+
dependencies = [
31+
'flake8>=3',
32+
'restructuredtext_lint',
33+
'pygments',
34+
]
35+
dynamic = ['version']
36+
[project.entry-points]
37+
'flake8.extension' = {RST = 'flake8_rst_docstrings:reStructuredTextChecker'}
38+
[project.optional-dependencies]
39+
develop = ['build', 'twine']
40+
[project.urls]
41+
Homepage = 'https://github.com/peterjc/flake8-rst-docstrings'
42+
'Source Code' = 'https://github.com/peterjc/flake8-rst-docstrings/'
43+
'Bug Tracker' = 'https://github.com/peterjc/flake8-rst-docstrings/issues'
44+
Documentation = 'https://github.com/peterjc/flake8-rst-docstrings/blob/master/README.rst'
45+
46+
[tool.setuptools]
47+
py-modules = ['flake8_rst_docstrings']
48+
zip-safe = true
49+
[tool.setuptools.dynamic]
50+
version = {attr = 'flake8_rst_docstrings.__version__'}

setup.py

Lines changed: 0 additions & 53 deletions
This file was deleted.

0 commit comments

Comments
 (0)