Skip to content

Commit 504d15b

Browse files
committed
DOC Update install and version support docs
1 parent 70f7b72 commit 504d15b

File tree

3 files changed

+20
-18
lines changed

3 files changed

+20
-18
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ in C++ for speed) operating over numpy arrays.
1212
[![Conda Downloads](https://anaconda.org/conda-forge/mahotas/badges/downloads.svg)](https://anaconda.org/conda-forge/mahotas)
1313
[![Install with conda](https://img.shields.io/badge/install%20with-conda-brightgreen.svg?style=flat)](https://anaconda.org/conda-forge/mahotas)
1414

15-
Python versions 3.7+, are supported.
15+
Python 3.7 through 3.13 are supported.
1616

1717
Notable algorithms:
1818

@@ -133,8 +133,8 @@ conda install mahotas
133133

134134
### Compilation from source
135135

136-
You will need python (naturally), numpy, and a C++ compiler. Then you
137-
should be able to use:
136+
You will need Python, NumPy, and a C++ compiler. Then you should be able to
137+
use:
138138

139139
```bash
140140
pip install mahotas
@@ -146,6 +146,12 @@ You can test your installation by running:
146146
python -c "import mahotas as mh; mh.test()"
147147
```
148148

149+
If you want an editable install for development, use:
150+
151+
```bash
152+
pip install -e .[tests]
153+
```
154+
149155
If you run into issues, the manual has more [extensive documentation on
150156
mahotas
151157
installation](https://mahotas.readthedocs.io/en/latest/install.html),
@@ -183,22 +189,24 @@ debug version:
183189

184190
```bash
185191
export DEBUG=1
186-
python setup.py test
192+
make debug
193+
pytest -v
187194
```
188195

189196
You can set it to the value `2` to get extra checks:
190197

191198
```bash
192199
export DEBUG=2
193-
python setup.py test
200+
make debug
201+
pytest -v
194202
```
195203

196204
Be careful not to use this in production unless you are chasing a bug.
197205
Debug level 2 is very slow as it adds many runtime checks.
198206

199207
The `Makefile` that is shipped with the source of mahotas can be useful
200208
too. `make debug` will create a debug build. `make fast` will create a
201-
non-debug build (you need to `make clean` in between). `make test` will
209+
non-debug build (you need to `make clean` in between). `make tests` will
202210
run the test suite.
203211

204212
## Links & Contacts

docs/source/install.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,15 @@ conda configuration, you can also install just mahotas with::
2121
From source
2222
-----------
2323

24+
Mahotas supports Python 3.7 through 3.13.
25+
2426
You can get the released version using pip::
2527

2628
pip install mahotas
2729

28-
If you prefer, you can download the source from `PyPI
29-
<https://pypi.python.org/pypi/mahotas>`__ and run::
30+
For development, install from a checkout with::
3031

31-
python setup.py install
32+
pip install -e .[tests]
3233

3334
You will need to have ``numpy`` and a ``C++`` compiler.
3435

@@ -38,7 +39,7 @@ Visual Studio
3839
For compiling from source in Visual Studio, use::
3940

4041
python setup.py build_ext -c msvc
41-
python setup.py install
42+
pip install .
4243

4344

4445
Bleeding Edge (Development)
@@ -103,4 +104,3 @@ Frugalware Linux
103104
~~~~~~~~~~~~~~~~
104105

105106
Mahotas is available as ``python-mahotas``.
106-

setup.py

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -121,13 +121,7 @@ def build_extensions(self):
121121
'Topic :: Scientific/Engineering :: Image Recognition',
122122
'Topic :: Software Development :: Libraries',
123123
'Programming Language :: Python',
124-
'Programming Language :: Python :: 2',
125-
'Programming Language :: Python :: 2.7',
126124
'Programming Language :: Python :: 3',
127-
'Programming Language :: Python :: 3.3',
128-
'Programming Language :: Python :: 3.4',
129-
'Programming Language :: Python :: 3.5',
130-
'Programming Language :: Python :: 3.6',
131125
'Programming Language :: Python :: 3.7',
132126
'Programming Language :: Python :: 3.8',
133127
'Programming Language :: Python :: 3.9',
@@ -148,6 +142,7 @@ def build_extensions(self):
148142
author = 'Luis Pedro Coelho',
149143
author_email = 'luis@luispedro.org',
150144
license = 'MIT',
145+
python_requires = '>=3.7',
151146
platforms = ['Any'],
152147
classifiers = classifiers,
153148
url = 'https://luispedro.org/software/mahotas',
@@ -167,4 +162,3 @@ def build_extensions(self):
167162
"tests": tests_require,
168163
},
169164
)
170-

0 commit comments

Comments
 (0)