feat: Nix development shell

[silky]

Description

This adds a simple Nix development shell based on pyproject.nix using direnv.

I've added this to allow development on NixOS/nix.

Note that there are a couple of quirks that, perhaps, are solvable, and I've opened as issues:

• https://github.com/nix-community/pyproject.nix/issues/67
• https://github.com/nix-community/pyproject.nix/issues/66

I also made some very small fixes in a couple of spots I noticed them; a missing link here or typo.

The main code change I had to make was to allow setting the __version__ attribute to fail; which is does in the nix environment. Hopefully this isn't too controversial as it should only affect nix. I opened https://github.com/nix-community/pyproject.nix/issues/66 to track this and hopefully there is an answer. As a bit of trivia, it might be more idiomatic (for nix, anyway) to have the version as a hard-coded file in the repository; then at least the nix package installation could also be made correct (see the flake.nix for a comment explaining this situation.)

For Nix people, note that I opted not to use pre-commit-hooks.nix (because it would mean moving the configuration of the hooks to Nix, which basically means you'd need to use nix to change them, which I didn't want to require), so you will need to run pre-commit install when entering the shell for the first time.

Let me know if there are any concerns/thoughts/extra things to do :)

If you wish to try this yourself, you would need to simply:

1. Install nix-the-package manager - https://nixos.org/download.html
2. From the folder with the flake run nix develop
3. Confirm it works by running pytest from the resulting shell! :)

Potential extensions:

• [ ] Set up CI to test that the devShell works.
  • I'm happy to do this we wish; it's probably a good idea, to make sure it doesn't break based at some point from some non-nix change, or otherwise. But, if it does break on a non-nix change it will require someone with a bit of nix experience to fix.

Checklist

• [x] Dependencies install correctly in a clean environment and code executes;
• [x] Test coverage extended; created tests fail without the change (if possible);
• [x] All tests passing;
• [x] Commits follow a type convention (e.g. https://gist.github.com/brianclements/841ea7bffdb01346392c#type);
• [x] Extended the README, documentation and/or docstrings, if necessary;

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
feo-client	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 11, 2024 9:22am

[silky]

Closing in favour of keeping Nix out of the repository for the time being :)