File tree Expand file tree Collapse file tree 3 files changed +10
-21
lines changed
Expand file tree Collapse file tree 3 files changed +10
-21
lines changed Original file line number Diff line number Diff line change @@ -41,10 +41,9 @@ where the exciting stuff is.
4141- ** Git LFS** : We have big integration test files, and we are using Git LFS to track them.
4242 [ Install ` git-lfs ` ] ( https://git-lfs.github.com/ ) from the website.
4343
44- - ** Rust** (_ Optional_ ): unblob has an optional Rust extension for performance
45- intensive processing. Building it is entirely optional and requires
46- [ ` rustup ` ] ( https://rustup.rs/ ) to be installed on the host system. Follow the
47- instructions on the [ rustup website] ( https://rustup.rs/ ) to install it.
44+ - ** Rust** (_ for unblob-native_ ): unblob has a [ Rust extension] ( https://github.com/onekey-sec/unblob-native ) for
45+ performance intensive processing. Building it is entirely optional and requires [ ` rustup ` ] ( https://rustup.rs/ ) to be
46+ installed on the host system. Follow the instructions on the [ rustup website] ( https://rustup.rs/ ) to install it.
4847
4948- ** pyenv** (_ Recommended_ ): When you are working with multiple versions of Python,
5049 pyenv makes it very easy to install and use different versions and make virtualenvs.
@@ -91,12 +90,8 @@ pyenv local 3.8.12
9190
9291### Installing Python dependencies
9392
94- We are using [ poetry] ( https://python-poetry.org/ ) to manage our Python dependencies.
95-
96- - If you installed Rust: run ` UNBLOB_BUILD_RUST_EXTENSION=1 poetry install `
97- to build and install the extension. Set ` RUST_DEBUG=1 ` to build it in debug mode.
98-
99- - ` poetry install ` will install all required dependencies for development.
93+ We are using [ poetry] ( https://python-poetry.org/ ) to manage our Python dependencies. `poetry
94+ install` will install all required dependencies for development.
10095
10196### Running pre-commit
10297
Original file line number Diff line number Diff line change @@ -75,7 +75,7 @@ unblob has been developed with the following objectives in mind:
7575 multi-processing by default, make sure to write efficient code, use
7676 memory-mapped files, and use [ Hyperscan] ( https://github.com/intel/hyperscan )
7777 as a high-performance matching library. Computation-intensive functions are
78- written in [ Rust] ( https://github.com/onekey-sec/unblob/tree/main/rust ) and
78+ written in [ Rust] ( https://github.com/onekey-sec/unblob-native ) and
7979 called from Python using specific bindings.
8080
8181## How does it work?
Original file line number Diff line number Diff line change 77
88Unblob consists of two main parts:
99
10- - unblob, the Python package (with optional Rust modules) .
10+ - unblob, the Python package.
1111- extractor command line tools like ` 7zip ` , ` unar ` , etc. (See [ Extractors] ( ./extractors.md ) for explanation.)
1212
1313All of these need to be installed to make unblob fully functional.
@@ -98,20 +98,14 @@ The Nix derivation installs all 3rd party dependencies.
9898
99994 . Install ** Python dependencies** with Poetry:
100100
101- 1 . _ Optional_ : With Rust optimizations
102- (you need a [ Rust compiler] ( https://www.rust-lang.org/tools/install ) ):
103-
104- cd unblob
105- UNBLOB_BUILD_RUST_EXTENSION=1 poetry install --no-dev
106-
107- 2 . Python packages only:
101+ 1 . Python packages:
108102
109103 cd unblob
110104 poetry install --no-dev
111105
112- 3 . Make sure you [ installed all extractors] ( #install-extractors ) .
106+ 2 . Make sure you [ installed all extractors] ( #install-extractors ) .
113107
114- 4 . Check that everything works correctly:
108+ 3 . Check that everything works correctly:
115109
116110 poetry run unblob --show-external-dependencies
117111
You can’t perform that action at this time.
0 commit comments