Skip to content

Commit c14cdf0

Browse files
committed
Install mapfile_parser as a command through pip for compatibility with uvx
1 parent c3062ea commit c14cdf0

6 files changed

Lines changed: 21 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Added
11+
12+
- Install a `mapfile_parser` program script when installing the library through
13+
`pip`.
14+
- This provides the same functionality as running the library module with
15+
`python3 -m mapfile_parser`.
16+
- This should allow better integration with tools like `uvx` or `pipx`.
17+
1018
## [2.11.0] - 2025-09-08
1119

1220
### Added

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
[package]
55
name = "mapfile_parser"
6-
version = "2.11.0"
6+
version = "2.12.0-dev0"
77
edition = "2021"
88
rust-version = "1.74.0"
99
authors = ["Anghelo Carvajal <angheloalf95@gmail.com>"]

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,12 @@ Various cli examples are provided in the [frontends folder](src/mapfile_parser/f
9595
Most of them are re-implementations of already existing tools using this
9696
library to show how to use this library and inspire new ideas.
9797

98-
The list can be checked in runtime with `python3 -m mapfile_parser --help`.
98+
The list can be checked in runtime with `python3 -m mapfile_parser --help` or
99+
`mapfile_parser --help`.
99100

100-
Each one of them can be executed with `python3 -m mapfile_parser utilityname`,
101-
for example `python3 -m mapfile_parser pj64_syms`.
101+
Each one of them can be executed with `python3 -m mapfile_parser utilityname` or
102+
`mapfile_parser utilityname`, for example `python3 -m mapfile_parser pj64_syms`
103+
or `mapfile_parser objdiff_report`.
102104

103105
- `bss_check`: Check that globally visible bss has not been reordered.
104106
- `first_diff`: Find the first difference(s) between the built ROM and the base

pyproject.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
[project]
55
name = "mapfile_parser"
6-
version = "2.11.0"
6+
version = "2.12.0-dev0"
77
description = "Map file parser library focusing decompilation projects"
88
readme = "README.md"
99
requires-python = ">=3.9"
@@ -25,6 +25,9 @@ classifiers = [
2525
requires = ["maturin>=1.2,<2.0"]
2626
build-backend = "maturin"
2727

28+
[project.scripts]
29+
mapfile_parser = "mapfile_parser.__main__:mapfileParserMain"
30+
2831
[tool.cibuildwheel]
2932
skip = ["cp36-*"]
3033

src/mapfile_parser/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
from __future__ import annotations
77

8-
__version_info__ = (2, 11, 0)
9-
__version__ = ".".join(map(str, __version_info__)) # + "-dev0"
8+
__version_info__ = (2, 12, 0)
9+
__version__ = ".".join(map(str, __version_info__)) + "-dev0"
1010
__author__ = "Decompollaborate"
1111

1212
from . import utils as utils

0 commit comments

Comments
 (0)