Skip to content

Commit 2587e2f

Browse files
authored
chore(build,docs): update dependencies and README #2
* nix flake update; bump setuptools version * poetry update * add nix instructions to README * update README instructions structure
1 parent 05925f6 commit 2587e2f

File tree

5 files changed

+861
-762
lines changed

5 files changed

+861
-762
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,40 @@ This should install the Python dependencies and create a new virtual environment
3636
Run Deject by typing the following command in the Deject directory:
3737
`poetry run deject`
3838

39+
## Building with Nix
40+
41+
This project contains `flake.nix` file, which means that following outputs can be produced:
42+
```
43+
├───devShells
44+
│ └───x86_64-linux
45+
│ └───default: development environment 'nix-shell'
46+
└───packages
47+
└───x86_64-linux
48+
├───default: package 'python3.11-deject-0.4.0'
49+
└───deject: package 'python3.11-deject-0.4.0'
50+
```
51+
52+
### devShell
53+
54+
`devShell` is, as the name suggest, dev-friendly environment, with all the required dependencies, to build and continue development of this project.
55+
This also creates a 'temporary' shell, with the built package provided, added to that given devShell PATH.
56+
57+
In order to do that, run the following in Deject's root dir:
58+
59+
`nix develop`
60+
61+
> no other information is required, as there's only one devShell associated with this flake
62+
63+
### binary output
64+
65+
If you want to build a binary of this project, using Nix, run the following inside Deject's root dir:
66+
67+
`nix build`
68+
69+
> no other information is required in this case neither, as both outputs for 'packages' are identical, as seen in the output of `nix flake show` above
70+
71+
This will create a directory `result`, and the deject binary will be located under `./result/bin/deject`.
72+
3973
## Tests
4074
To run the tests, to check that Deject is working correct, use the following command in the Deject directory:
4175

flake.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

nix/default.nix

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
telfhash,
2727
typer,
2828
yara-python,
29+
# setuptools,
2930
# from overlay
3031
chepy,
3132
dotnetfile,
@@ -97,6 +98,7 @@ in
9798
typer
9899
yara-python
99100
pyyaml
101+
# setuptools
100102

101103
chepy
102104
dotnetfile

0 commit comments

Comments
 (0)