mxdev [mɪks dɛv] is a utility that makes it easy to work with Python projects containing lots of packages, of which you only want to develop some.
It builds on top of the idea to have stable version constraints and then develop from a VCS on top of it.
As part of the above use-case sometimes versions of the stable constraints need an override with a different (i.e. newer) version. Other software follow the same idea are mr.developer for Python's zc.buildout or mrs-developer for NPM packages.
mxdev procedure is:
- Configuration is read,
- Requirements and constraints (given in the configuration) are read.
- Sources from VCS are fetched into a target directory,
- Modified constraints (handled packages commented, overridden versions replaced) and requirements (handled packages as editable from sources) are written.
mxdev will not run pip for you!
Given a requirements.txt (or similar named) file which itself references a constraints.txt file inside.
Create an INI file, like mx.ini in configparser.ExtendedInterpolation syntax.
The main section must be called [settings], even if kept empty.
In the main sections the input and output files are defined.
Main requirements file to start with. This can be an URL too.
If given an empty value mxdev will only generate output from the information given in INI file itself.
Default: requirements.txt
Output of the combined requirements including development sources to be used later with pip install.
Default: requirements-mxdev.txt
Output of the combined constraints.
Default: constraints-mxdev.txt
Include one or more other INI files.
The included file is read before the main file, so the main file overrides included settings. Included files may include other files. Innermost inclusions are read first.
If an included file is an HTTP-URL, it is loaded from there.
If the included file is a relative path, it is loaded relative to the parents directory or URL.
The feature utilizes the ConfigParser feature to read multiple files at once.
Default: empty
Target directory for sources from VCS. Default: ./sources
Default for install-mode on section, read there for details
Allowed values: direct or skip
Default: direct
Default for update on section, read there for details
Allowed values: yes or no
Default: yes
Number of threads to fetch sources in parallel with. Speeds up fetching from VCS.
Default: 4
Do not fetch any sources. Handy if working offline.
Default: False
Override package versions which are already defined in a dependent constraints file.
I.e. an upstream constraints.txt contains already somefancypackage==2.0.3.
Given that, for some reason (like with my further developed sources), we need version 3.0.0 of the above package.
Then in this section, this can be defined as:
[settings]
version-overrides =
somefancypackage==3.0.0
otherpackage==33.12.1It is possible to add as many overrides as needed. When writing the constraints-out, the new version will be taken into account. If there is a source section defined for the same package, the source will be used and entries here are ignored.
Note: When using uv pip install the version overrides here are not needed, since it supports overrides nativly.
With uv it is recommended to create an overrides.txt file with the version overrides and use uv pip install --overrides overrides.txt [..] to install the packages.
Ignore packages that are already defined in a dependent constraints file.
No new version will be provided.
This is specifically handy if a package is going to be installed editable from local file system (like -e .), but was already pinned in an upstream constraints file.
This can be defined as:
[settings]
ignores =
somefancypackage
otherpackageTrue by default. When false, the source is not checked out,
and the version for this package is not overridden.
Additionally, custom variables can be defined as key = value pair.
Those can be referenced in other values as ${settings:key} and will be expanded there.
mxdev can handle one Python package as main package directly via ini config. If defined, it will be added as last entry in the resulting requirements out file.
This can be defined as:
[settings]
main-package = -e .[test]If the main package is defined in a dependent constraint file, it's name must be added to ignores.
mxdev provides default settings which can be used inside package or custom sections.
Contains the current working directory and can be used like this
[sectionname]
param = ${settings:directory}/some/pathAll other sections are defining the sources to be used.
The section name is the package name.
The checkout URL of the repository.
The URL is required.
Optional a writable URL for pushes can be specified.
If the pushurl is set after initial checkout it is not applied.
To apply it remove the repository and checkout again.
The version control system to use.
Supported are:
git(stable, tested)fs(stable, tested) - in fact no vcs, but points to a local directory. This can be achieved without mxdev by using-e PATHin the requirements input file.svn(unstable, test needs rewrite)gitsvn(unstable, test needs rewrite)hg(unstable, test needs rewrite)bzr(unstable, test needs rewrite)darcs(unstable, test needs rewrite)
Defaults to git.
The branch name or tag to checkout.
Defaults to main.
Package extras to install. Default empty.
For specifying the path to the Python package, when it is not in the root of the VCS directory.
Default empty.
The target directory for source from this section.
Default to default target directory configured in the main section [settings] default-target = value.
There are different modes of pip installation
Do not install with pip, just clone/update the repository
Install the package using pip -e PACKAGEPATH.
Dependencies are resolved immediately
Defaults to default mode configured in main section [settings] default-install-mode = value.
True by default, unless default-use in the general settings is false.
When false, the source is not checked out,
and the version for this package is not overridden.
There are 3 different options:
(default) git submodules will always be checked out, they will be updated if already presen
submodules get only fetched during checkout, existing submodules stay untouche
Fetches submodules recursively, results in git clone --recurse-submodules on checkout and submodule update --init --recursive on update.
Run mxdev (for more options run mxdev --help).
Mxdev will
- read the configuration from
mx.ini, - fetch the packages defined in the config file and
- write a requirements and constraints file.
Now, use the generated requirements and constraints files with i.e. pip install -r requirements-mxdev.txt.
mxdev >=4.0 needs pip version 23 at minimum to work properly
This looks like so:
[settings]
requirements-in = requirements.txt
requirements-out = requirements-mxdev.txt
contraints-out = constraints-mxdev.txt
version-overrides =
baz.baaz = 1.9.32
ignores =
my.ignoredpackage
# custom variables
github = git+ssh://git@github.com/
mygit = git+ssh://git@git.kup.tirol/
[foo.bar]
url = ${settings:github}orga/foo.bar.git
branch = fix99
extras = test,baz
[kup.fancyproject]
url = ${settings:mygit}customers/fancycorp/kup.fancyproject.git
branch = fix99
extras = test,baz- "new" plone.org backend
- Conestack
- (add more)
The functionality of mxdev can be extended by hooks. This is useful to generate additional scripts or files or automate any other setup steps related to mxdev's domain.
Extension configuration settings end up in the mx.ini file.
They can be added globally to the settings section, as dedicated config sections or package specific.
To avoid naming conflicts, all hook-related settings and config sections must be prefixed with a namespace.
It is recommended to use the package name containing the hook as a namespace.
This looks like so:
[settings]
myextension-global_setting = 1
[myextension-section]
setting = value
[foo.bar]
myextension-package_setting = 1The extension is implemented as a subclass of mxdev.Hook:
from mxdev import Hook
from mxdev import State
class MyExtension(Hook):
namespace = None
"""The namespace for this hook."""
def read(self, state: State) -> None:
"""Gets executed after mxdev read operation."""
def write(self, state: State) -> None:
"""Gets executed after mxdev write operation."""The default settings section from the INI file is available at state.configuration.settings.
The package configuration is available at state.configuration.packages.
Hook-related config sections are available at state.configuration.hooks.
The hook must be registered as an entry point in the pyproject.toml of your package:
[project.entry-points.mxdev]
hook = "myextension:MyExtension"There is a constraint file like -c constraints.txt with a package foo.bar with a version pin.
Then it is not possible to install this package in a requirements file editable like -r requirements.txt with -e git+ssh://git@github.com/orga/foo.bar.git@fix-99.
Neither it is possible to override inherited version constraints with custom ones.
A pre-processor fetches (as this can be an URL) and expands all -c SOMEOTHER_FILE_OR_URL and -r SOMEOTHER_FILE_OR_URL files into one, filtering out all packages given in a configuration file.
For each of those packages, a -e ... entry is generated instead and written to a new TARGET.txt.
Same is true for version overrides: a new entry is written to the resulting constraints file while the original version is disabled.
The configuration is read from a file mx.ini in ExtendedInterpolation INI syntax (YAML would be nice, but the package must have as less dependencies as possible to other packages).
Mx (generally pronounced like mix [mɪks], or [məks] in the UK) is meant to be a gender-neutral alternative to the titles Mr. and Ms. but also associates with the word "mix".
The VCS-related code is taken from mr.developer.
Thanks to Florian Schulze and Contributors.