docs: Add skeletal documentation of highbank and midway
[qemu.git] / python / setup.cfg
blob14bab9028836a91e32c4361fb54c527567af7297
1 [metadata]
2 name = qemu
3 version = file:VERSION
4 maintainer = QEMU Developer Team
5 maintainer_email = qemu-devel@nongnu.org
6 url = https://www.qemu.org/
7 download_url = https://www.qemu.org/download/
8 description = QEMU Python Build, Debug and SDK tooling.
9 long_description = file:PACKAGE.rst
10 long_description_content_type = text/x-rst
11 classifiers =
12     Development Status :: 3 - Alpha
13     License :: OSI Approved :: GNU General Public License v2 (GPLv2)
14     Natural Language :: English
15     Operating System :: OS Independent
16     Programming Language :: Python :: 3 :: Only
17     Programming Language :: Python :: 3.6
18     Programming Language :: Python :: 3.7
19     Programming Language :: Python :: 3.8
20     Programming Language :: Python :: 3.9
21     Programming Language :: Python :: 3.10
22     Typing :: Typed
24 [options]
25 python_requires = >= 3.6
26 packages =
27     qemu.qmp
28     qemu.machine
29     qemu.utils
31 [options.package_data]
32 * = py.typed
34 [options.extras_require]
35 # For the devel group, When adding new dependencies or bumping the minimum
36 # version, use e.g. "pipenv install --dev pylint==3.0.0".
37 # Subsequently, edit 'Pipfile' to remove e.g. 'pylint = "==3.0.0'.
38 devel =
39     avocado-framework >= 87.0
40     flake8 >= 3.6.0
41     fusepy >= 2.0.4
42     isort >= 5.1.2
43     mypy >= 0.770
44     pylint >= 2.8.0
45     tox >= 3.18.0
47 # Provides qom-fuse functionality
48 fuse =
49     fusepy >= 2.0.4
51 [options.entry_points]
52 console_scripts =
53     qom = qemu.qmp.qom:main
54     qom-set = qemu.qmp.qom:QOMSet.entry_point
55     qom-get = qemu.qmp.qom:QOMGet.entry_point
56     qom-list = qemu.qmp.qom:QOMList.entry_point
57     qom-tree = qemu.qmp.qom:QOMTree.entry_point
58     qom-fuse = qemu.qmp.qom_fuse:QOMFuse.entry_point [fuse]
59     qemu-ga-client = qemu.qmp.qemu_ga_client:main
60     qmp-shell = qemu.qmp.qmp_shell:main
62 [flake8]
63 extend-ignore = E722  # Prefer pylint's bare-except checks to flake8's
64 exclude = __pycache__,
66 [mypy]
67 strict = True
68 python_version = 3.6
69 warn_unused_configs = True
70 namespace_packages = True
72 [mypy-qemu.qmp.qom_fuse]
73 # fusepy has no type stubs:
74 allow_subclassing_any = True
76 [mypy-fuse]
77 # fusepy has no type stubs:
78 ignore_missing_imports = True
80 [pylint.messages control]
81 # Disable the message, report, category or checker with the given id(s). You
82 # can either give multiple identifiers separated by comma (,) or put this
83 # option multiple times (only on the command line, not in the configuration
84 # file where it should appear only once). You can also use "--disable=all" to
85 # disable everything first and then reenable specific checks. For example, if
86 # you want to run only the similarities checker, you can use "--disable=all
87 # --enable=similarities". If you want to run only the classes checker, but have
88 # no Warning level messages displayed, use "--disable=all --enable=classes
89 # --disable=W".
90 disable=
92 [pylint.basic]
93 # Good variable names which should always be accepted, separated by a comma.
94 good-names=i,
95            j,
96            k,
97            ex,
98            Run,
99            _,   # By convention: Unused variable
100            fh,  # fh = open(...)
101            fd,  # fd = os.open(...)
102            c,   # for c in string: ...
104 [pylint.similarities]
105 # Ignore imports when computing similarities.
106 ignore-imports=yes
108 [isort]
109 force_grid_wrap=4
110 force_sort_within_sections=True
111 include_trailing_comma=True
112 line_length=72
113 lines_after_imports=2
114 multi_line_output=3
116 # tox (https://tox.readthedocs.io/) is a tool for running tests in
117 # multiple virtualenvs. This configuration file will run the test suite
118 # on all supported python versions. To use it, "pip install tox" and
119 # then run "tox" from this directory. You will need all of these versions
120 # of python available on your system to run this test.
122 [tox:tox]
123 envlist = py36, py37, py38, py39, py310
124 skip_missing_interpreters = true
126 [testenv]
127 allowlist_externals = make
128 deps =
129     .[devel]
130     .[fuse]  # Workaround to trigger tox venv rebuild
131 commands =
132     make check