Nix development environment? #766

New Issue

Closed

opened 2023-10-05 13:58:32 +00:00 by pizzapim · 4 comments

pizzapim commented 2023-10-05 13:58:32 +00:00

Contributor

Copy Link

I recently learned Nix (https://nixos.org/) and to work on the project, I created a Nix development environment which worked great for me. Perhaps it might be worth adding support for it, or just putting it in documentation? I uploaded the code on this branch: https://projects.torsion.org/pizzapim/borgmatic/src/branch/nix-dev-env

The idea is as follows: direnv (https://direnv.net/) automatically activates some environment which is specified in the .envrc file. This file in turn says to activate a Nix shell specified in the flake.nix file. This Nix shell makes some programs available (Python 3.11, borgbackup) and Python libraries (apprise, pipx, tox, etc.) in an ephemeral shell. If you move out of this directory, the shell is unloaded are not longer available.

I recently learned Nix (https://nixos.org/) and to work on the project, I created a Nix development environment which worked great for me. Perhaps it might be worth adding support for it, or just putting it in documentation? I uploaded the code on this branch: https://projects.torsion.org/pizzapim/borgmatic/src/branch/nix-dev-env The idea is as follows: direnv (https://direnv.net/) automatically activates some environment which is specified in the `.envrc` file. This file in turn says to activate a Nix shell specified in the `flake.nix` file. This Nix shell makes some programs available (Python 3.11, borgbackup) and Python libraries (apprise, pipx, tox, etc.) in an ephemeral shell. If you move out of this directory, the shell is unloaded are not longer available.

witten commented 2023-10-05 16:16:12 +00:00

Owner

Copy Link

Pull requests welcome! 😄 I don't know much about NixOS, but the only issue I see is that a particular NixOS version and a particular Python version are encoded in that flake.nix file. So that would just need to be kept up-to-date or somehow parameterized.

A question though: In this ephemeral shell, are state files like .tox left behind.. or deleted after use? Because if those are ephemeral too, then you'll have to recreate your Tox environment every time you work on borgmatic. Honestly, not the worst thing in the world, and it might actually be kind of useful so you don't have to know when to run tox -r manually...

If this were to get merged into borgmatic, I think there should be at least a mention on the borgmatic dev documentation page: https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/

Pull requests welcome! 😄 I don't know much about NixOS, but the only issue I see is that a particular NixOS version and a particular Python version are encoded in that flake.nix file. So that would just need to be kept up-to-date or somehow parameterized. A question though: In this ephemeral shell, are state files like `.tox` left behind.. or deleted after use? Because if those are ephemeral too, then you'll have to recreate your Tox environment every time you work on borgmatic. Honestly, not the worst thing in the world, and it might actually be kind of useful so you don't have to know when to run `tox -r` manually... If this were to get merged into borgmatic, I think there should be at least a mention on the borgmatic dev documentation page: https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/

pizzapim commented 2023-10-08 10:09:18 +00:00

Author

Contributor

Copy Link

Yeah, I don't think there is a ready way to automate synchronization between setup.py and the Nix flake. So if any dependencies are updated, they would need to be updated in the flake configuration as well by hand. It's probably not worth the effort to support two different dev environments. I was maybe thinking of a small sidenote in the dev documentation page with an (unsupported) example setup instead?

About your question: only the things specificed in flake.nix are ephemeral in the shell. Any side-effects like the .tox directory would remain after exiting the shell.

Yeah, I don't think there is a ready way to automate synchronization between `setup.py` and the Nix flake. So if any dependencies are updated, they would need to be updated in the flake configuration as well by hand. It's probably not worth the effort to support two different dev environments. I was maybe thinking of a small sidenote in the dev documentation page with an (unsupported) example setup instead? About your question: only the things specificed in flake.nix are ephemeral in the shell. Any side-effects like the `.tox` directory would remain after exiting the shell.

witten commented 2023-12-23 23:20:50 +00:00

Owner

Copy Link

Sorry for the delay here. Yes, an unsupported example or a link to a separate repository from the dev docs would be fine IMO. PRs welcome!

Sorry for the delay here. Yes, an unsupported example or a link to a separate repository from the dev docs would be fine IMO. PRs welcome!

witten commented 2024-03-12 04:21:19 +00:00

Owner

Copy Link

Closing this for now due to inactivity, but I'd be happy to revisit this if you'd still like to discuss!

Closing this for now due to inactivity, but I'd be happy to revisit this if you'd still like to discuss!

witten closed this issue 2024-03-12 04:21:19 +00:00

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

spot-check

1.8.10

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.15

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.24

1.5.23

1.5.22

1.5.21

1.5.20

1.5.19

1.5.18

1.5.17

1.5.16

1.5.15

1.5.14

1.5.13

1.5.12

1.5.11

1.5.10

1.5.9

1.5.8

1.5.7

1.5.7.dev0

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.22

1.4.21

1.4.20

1.4.19

1.4.18

1.4.17

1.4.16

1.4.15

1.4.14

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.26

1.3.25

1.3.24

1.3.23

1.3.22

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

1.0.1

1.0.0

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

Labels

Clear labels   

bug

  

data loss

  

design finalized

  

good first issue

  

new feature area

  

question / support

  

security

  

waiting for response

No Label

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

Milestone

Clear milestone

No items

No Milestone

Assignees

Clear assignees

No Assignees

2 Participants

Notifications

Subscribe

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#766

No description provided.