mitkPipPackageInfo.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkPipPackageInfo_h
#define mitkPipPackageInfo_h
 
#include <MitkPythonInstallerExports.h>
 
#include <nlohmann/json_fwd.hpp>
 
#include <string>
#include <vector>
 
namespace mitk
{
  enum class PackageStatus
  {
    Pending,
    Installing,
    Installed,
    Failed
  };
 
  struct MITKPYTHONINSTALLER_EXPORT PipPackageInfo
  {
    std::string name;       
    std::string version;    
    std::string specifier;  
    bool requested = false; 
    int group = 0;          
  };
 
  struct MITKPYTHONINSTALLER_EXPORT PipInstallGroup
  {
    PipInstallGroup() = default;
 
    PipInstallGroup(std::initializer_list<std::string> requirements);
 
    std::vector<std::string> requirements; 
    std::string indexUrl;                  
    std::vector<std::string> extraPipArgs; 
  };
 
  struct MITKPYTHONINSTALLER_EXPORT PostInstallStep
  {
    std::string displayName; 
    std::string pythonCode;  
    bool optional = false;   
  };
 
  struct MITKPYTHONINSTALLER_EXPORT PipInstallSpec
  {
    std::string name;                      
    std::string venvName;                  
    std::vector<PipInstallGroup> groups;   
    bool upgradePipFirst = true;           
    std::vector<PostInstallStep> postInstallSteps; 
    static PipInstallSpec FromFile(const std::string& path);
 
    static PipInstallSpec FromResource(const std::string& resourcePath);
 
    void SaveToFile(const std::string& path) const;
  };
 
  MITKPYTHONINSTALLER_EXPORT void from_json(const nlohmann::ordered_json& j, PipInstallGroup& g);
  MITKPYTHONINSTALLER_EXPORT void to_json(nlohmann::ordered_json& j, const PipInstallGroup& g);
 
  MITKPYTHONINSTALLER_EXPORT void from_json(const nlohmann::ordered_json& j, PostInstallStep& s);
  MITKPYTHONINSTALLER_EXPORT void to_json(nlohmann::ordered_json& j, const PostInstallStep& s);
 
  MITKPYTHONINSTALLER_EXPORT void from_json(const nlohmann::ordered_json& j, PipInstallSpec& s);
  MITKPYTHONINSTALLER_EXPORT void to_json(nlohmann::ordered_json& j, const PipInstallSpec& s);
}
 
#endif