Nix
============

Installation
------------

.. warning::
    This will install the latest (git) version of Ignis.
    Please refer to the `latest documentation <https://ignis-sh.github.io/ignis/latest/index.html>`_.

Add Ignis to the flake's inputs:

.. code-block:: nix

    {
      inputs = {
        nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
        home-manager = {
          url = "github:nix-community/home-manager";
          inputs.nixpkgs.follows = "nixpkgs";
        };
        ignis = {
          url = "github:ignis-sh/ignis";
          # ! Important to override
          # Nix will not allow overriding dependencies if the input
          # doesn't follow your system pkgs
          inputs.nixpkgs.follows = "nixpkgs";
        };
      };
    }

Then, add the following to ``environment.systemPackages`` or ``home.packages``:

.. code-block:: nix

    inputs.ignis.packages.${system}.ignis


.. note::

    Remember to pass ``inputs`` 
    to ``extraSpecialArgs`` for Home Manager
    and ``specialArgs`` for the NixOS host configuration.

    See :ref:`basic-flake-example`.

Extra Dependencies
------------------

To add extra dependencies, use the ``<pkg>.override`` function and pass the ``extraPackages`` argument to it.

.. tab-set::

    .. tab-item:: configuration.nix

        .. code-block:: nix

            { config, pkgs, lib, inputs, ... }: {
              environment.systemPackages = [
                (inputs.ignis.packages.${pkgs.stdenv.hostPlatform.system}.ignis.override {
                  extraPackages = [
                    # Add extra dependencies here
                    # For example:
                    pkgs.python312Packages.psutil
                    pkgs.python312Packages.jinja2
                    pkgs.python312Packages.pillow
                    pkgs.python312Packages.materialyoucolor
                  ];
                })
              ];
            }

    .. tab-item:: home.nix

        .. code-block:: nix

            { config, pkgs, lib, inputs, ... }: {
              home.packages = [
                (inputs.ignis.packages.${pkgs.stdenv.hostPlatform.system}.ignis.override {
                  extraPackages = [
                    # Add extra dependencies here
                    # For example:
                    pkgs.python312Packages.psutil
                    pkgs.python312Packages.jinja2
                    pkgs.python312Packages.pillow
                    pkgs.python312Packages.materialyoucolor
                  ];
                })
              ];
            }


Tips and Tricks
---------------

Adding Ignis to System Python
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can make Ignis accessible to the system Python interpreter.
This is especially useful if the LSP server of your text editor is not able to find Ignis.


.. tab-set::

    .. tab-item:: home.nix

        .. code-block:: nix

          { config, pkgs, inputs, ... }: {
            home.packages = with pkgs; [
              (python3.withPackages(ps: with ps; [
                (inputs.ignis.packages.${pkgs.stdenv.hostPlatform.system}.ignis.override {
                  extraPackages = [
                    # Add extra packages if needed
                  ];
                })
              ]))
            ];
          }


.. danger::
    You must choose only one of the described methods.
    Do not add Ignis to the system Python if you have already added it as a package.

    Otherwise, Ignis may not be able to find extra dependencies.

.. _basic-flake-example:

The basic Flake example
^^^^^^^^^^^^^^^^^^^^^^^

.. tab-set::

    .. tab-item:: flake.nix

      .. code-block:: nix

          {
            inputs = {
              nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
              home-manager = {
                url = "github:nix-community/home-manager";
                inputs.nixpkgs.follows = "nixpkgs";
              };
              ignis = {
                url = "github:ignis-sh/ignis";
                inputs.nixpkgs.follows = "nixpkgs";
              };
            };

            outputs = { self, nixpkgs, home-manager, ... }@inputs: let
              system = "x86_64-linux";
              lib = nixpkgs.lib;
              extraSpecialArgs = { inherit system inputs; };  # <- passing inputs to the attribute set for home-manager
              specialArgs = { inherit system inputs; };       # <- passing inputs to the attribute set for NixOS
            in {
              nixosConfigurations = {
                dummy-hostname = lib.nixosSystem {
                  modules = [
                    inherit specialArgs;  # <- this will make inputs available anywhere in the NixOS configuration
                    ./path/to/configuration.nix
                    home-manager.nixosModules.home-manager {
                      home-manager = {
                        inherit extraSpecialArgs;  # <- this will make inputs available anywhere in the HM configuration
                        useGlobalPkgs = true;
                        useUserPackages = true;
                        users.yourUserName = import ./path/to/home.nix;
                      };
                    }
                  ];
                };
              };
            };
          }