Merge pull request #526 from sanders41/extra-package-dev

Add option to add extra dev dependencies

Author: sanders41

README.md

@@ -201,13 +201,20 @@ python-project create -s
 - Extra Python Dependencies
 
   These are extra packages you want to include in the project that are not provided by default.
-  For example specifying `fastapi, camel-converter` here will these two packages in the
+  For example specifying `fastapi, camel-converter` here will inculde these two packages in the
   dependencies. If the project is an application the version will be pinned to the latest release
   of the packages, and if it is a library the latest release will be used for the minimum version.
-  If you would like to specify a specific version instead you can by the version with an `@`.
-  For example `[email protected], [email protected]`. When creating an appliction FastAPI will
-  be pinned to `0.115.0` and Camel Converter will be pinned to `4.0.0`, or if creating a library
-  these versions will be used for the minimum version.
+  If you would like to specify a specific version instead you can by specifying the version with an
+  `@`. For example `[email protected], [email protected]`. When creating an appliction FastAPI
+  will be pinned to `0.115.0` and Camel Converter will be pinned to `4.0.0`, or if creating a
+  library these versions will be used for the minimum version.
+
+- Extra Python Dev Dependencies
+
+  These are extra packages you want to include in the project's dev dependencies that are not
+  provided by default. For example specifying `pytest-xdist` here will include this package in the
+  dev dependencies. If you would like to specify a specific version instead of checking for the
+  latest you can by specifying the version with an `@`. For example `[email protected]`.
 
 After running the generator a new directory will be created with the name you used for the
 `Project Slug`. Change to this directory then install the python packages and pre-commit hooks.

src/cli.rs

@@ -165,6 +165,12 @@ pub enum Param {
     /// Remove the saved extra Python dependencies
     ResetExtraPythonPackages,
 
+    /// Extra Python dev dependencies to include in the project
+    ExtraPythonDevPackages { value: Vec<String> },
+
+    /// Remove the saved extra Python dev dependencies
+    ResetExtraPythonDevPackages,
+
     /// Rerset the config to the default values
     Reset,
 

src/config.rs

@@ -34,6 +34,7 @@ pub struct Config {
     pub include_docs: Option<bool>,
     pub download_latest_packages: Option<bool>,
     pub extra_python_packages: Option<Vec<String>>,
+    pub extra_python_dev_packages: Option<Vec<String>>,
 
     #[serde(skip)]
     config_dir: Rc<Option<PathBuf>>,
@@ -63,6 +64,7 @@ impl Default for Config {
             include_docs: None,
             download_latest_packages: None,
             extra_python_packages: None,
+            extra_python_dev_packages: None,
             config_dir: config_dir(),
             config_file_path: config_file_path(),
         }
@@ -96,6 +98,7 @@ impl Config {
                             include_docs: config.include_docs,
                             download_latest_packages: config.download_latest_packages,
                             extra_python_packages: config.extra_python_packages,
+                            extra_python_dev_packages: config.extra_python_dev_packages,
                             config_dir: self.config_dir.clone(),
                             config_file_path: self.config_file_path.clone(),
                         };
@@ -355,6 +358,16 @@ impl Config {
         Ok(())
     }
 
+    pub fn save_extra_python_dev_packages(&self, value: Vec<String>) -> Result<()> {
+        self.handle_save_config(|config| &mut config.extra_python_packages, Some(value))?;
+        Ok(())
+    }
+
+    pub fn reset_extra_python_dev_packages(&self) -> Result<()> {
+        self.handle_save_config(|config| &mut config.extra_python_packages, None)?;
+        Ok(())
+    }
+
     fn handle_save_config<F, T>(&self, func: F, value: Option<T>) -> Result<()>
     where
         F: FnOnce(&mut Self) -> &mut Option<T>,
@@ -418,6 +431,16 @@ impl Config {
         } else {
             println!("{}: null", extra_python_packages_label.blue());
         }
+        let extra_python_dev_packages_label = "Extra Python Dev Packages";
+        if let Some(extra_python_dev_packages) = config.extra_python_dev_packages {
+            let extra_python_dev_packages_str = extra_python_dev_packages.join(", ");
+            println!(
+                "{}: {extra_python_dev_packages_str}",
+                extra_python_dev_packages_label.blue()
+            );
+        } else {
+            println!("{}: null", extra_python_dev_packages_label.blue());
+        }
     }
 }
 

src/github_actions.rs

@@ -1336,6 +1336,7 @@ mod tests {
             include_docs: false,
             docs_info: None,
             extra_python_packages: None,
+            extra_python_dev_packages: None,
             download_latest_packages: false,
             project_root_dir: Some(tempdir().unwrap().path().to_path_buf()),
         }

src/licenses.rs

@@ -289,6 +289,7 @@ mod tests {
             include_docs: false,
             docs_info: None,
             extra_python_packages: None,
+            extra_python_dev_packages: None,
             download_latest_packages: false,
             project_root_dir: Some(tempdir().unwrap().path().to_path_buf()),
         }

src/main.rs

@@ -389,6 +389,18 @@ fn main() {
                     exit(1);
                 }
             }
+            Param::ExtraPythonDevPackages { value } => {
+                if let Err(e) = Config::default().save_extra_python_dev_packages(value) {
+                    print_error(e);
+                    exit(1);
+                }
+            }
+            Param::ResetExtraPythonDevPackages {} => {
+                if let Err(e) = Config::default().reset_extra_python_dev_packages() {
+                    print_error(e);
+                    exit(1);
+                }
+            }
             Param::Reset => {
                 if Config::reset().is_err() {
                     let message = "Error resetting config.";
@@ -444,6 +456,7 @@ mod tests {
             include_docs: false,
             docs_info: None,
             extra_python_packages: None,
+            extra_python_dev_packages: None,
             download_latest_packages: false,
             project_root_dir: Some(base),
         };

src/project_generator.rs

@@ -366,6 +366,24 @@ fn build_latest_dev_dependencies(project_info: &ProjectInfo) -> Result<String> {
         }
     }
 
+    if let Some(extras) = &project_info.extra_python_dev_packages {
+        for extra in extras {
+            if let Ok(p) = ExtraPythonPackageVersion::new(extra.to_lowercase().clone()) {
+                if let ProjectManager::Poetry = project_info.project_manager {
+                    version_string.push_str(&format!("{} = \"{}\"\n", p.package, p.version));
+                } else {
+                    version_string.push_str(&format!("{}=={}\n", p.package, p.version));
+                }
+            } else {
+                let error_message = format!(
+                    "Error retrieving latest python package version for {}, skipping.",
+                    extra
+                );
+                println!("\n{}", error_message.yellow());
+            }
+        }
+    }
+
     match project_info.project_manager {
         ProjectManager::Poetry => Ok(version_string.trim().to_string()),
         ProjectManager::Uv => {
@@ -1156,6 +1174,7 @@ mod tests {
             include_docs: false,
             docs_info: None,
             extra_python_packages: None,
+            extra_python_dev_packages: None,
             download_latest_packages: false,
             project_root_dir: Some(tempdir().unwrap().path().to_path_buf()),
         }
@@ -1279,6 +1298,26 @@ mod tests {
         assert_yaml_snapshot!(content);
     }
 
+    #[test]
+    fn test_save_poetry_pyproject_toml_with_python_dev_extras() {
+        let mut project_info = project_info_dummy();
+        project_info.project_manager = ProjectManager::Poetry;
+        project_info.extra_python_dev_packages = Some(vec![
+            "[email protected]".to_string(),
+            "[email protected]".to_string(),
+        ]);
+        let base = project_info.base_dir();
+        create_dir_all(&base).unwrap();
+        let expected_file = base.join("pyproject.toml");
+        save_pyproject_toml_file(&project_info).unwrap();
+
+        assert!(expected_file.is_file());
+
+        let content = std::fs::read_to_string(expected_file).unwrap();
+
+        assert_yaml_snapshot!(content);
+    }
+
     #[test]
     fn test_save_poetry_pyproject_toml_file_apache_application() {
         let mut project_info = project_info_dummy();
@@ -1393,6 +1432,26 @@ mod tests {
         assert_yaml_snapshot!(content);
     }
 
+    #[test]
+    fn test_save_pyo3_pyproject_toml_with_python_dev_extras() {
+        let mut project_info = project_info_dummy();
+        project_info.project_manager = ProjectManager::Maturin;
+        project_info.extra_python_dev_packages = Some(vec![
+            "[email protected]".to_string(),
+            "[email protected]".to_string(),
+        ]);
+        let base = project_info.base_dir();
+        create_dir_all(&base).unwrap();
+        let expected_file = base.join("pyproject.toml");
+        save_pyproject_toml_file(&project_info).unwrap();
+
+        assert!(expected_file.is_file());
+
+        let content = std::fs::read_to_string(expected_file).unwrap();
+
+        assert_yaml_snapshot!(content);
+    }
+
     #[test]
     fn test_save_pyproject_toml_file_apache_pyo3() {
         let mut project_info = project_info_dummy();
@@ -1489,6 +1548,26 @@ mod tests {
         assert_yaml_snapshot!(content);
     }
 
+    #[test]
+    fn test_save_setuptools_pyproject_toml_with_python_dev_extras() {
+        let mut project_info = project_info_dummy();
+        project_info.project_manager = ProjectManager::Setuptools;
+        project_info.extra_python_dev_packages = Some(vec![
+            "[email protected]".to_string(),
+            "[email protected]".to_string(),
+        ]);
+        let base = project_info.base_dir();
+        create_dir_all(&base).unwrap();
+        let expected_file = base.join("pyproject.toml");
+        save_pyproject_toml_file(&project_info).unwrap();
+
+        assert!(expected_file.is_file());
+
+        let content = std::fs::read_to_string(expected_file).unwrap();
+
+        assert_yaml_snapshot!(content);
+    }
+
     #[test]
     fn test_save_setuptools_pyproject_toml_file_apache_application() {
         let mut project_info = project_info_dummy();
@@ -1603,6 +1682,26 @@ mod tests {
         assert_yaml_snapshot!(content);
     }
 
+    #[test]
+    fn test_save_uv_pyproject_toml_with_python_dev_extras() {
+        let mut project_info = project_info_dummy();
+        project_info.project_manager = ProjectManager::Uv;
+        project_info.extra_python_dev_packages = Some(vec![
+            "[email protected]".to_string(),
+            "[email protected]".to_string(),
+        ]);
+        let base = project_info.base_dir();
+        create_dir_all(&base).unwrap();
+        let expected_file = base.join("pyproject.toml");
+        save_pyproject_toml_file(&project_info).unwrap();
+
+        assert!(expected_file.is_file());
+
+        let content = std::fs::read_to_string(expected_file).unwrap();
+
+        assert_yaml_snapshot!(content);
+    }
+
     #[test]
     fn test_save_uv_pyproject_toml_file_apache_application() {
         let mut project_info = project_info_dummy();
@@ -1717,6 +1816,26 @@ mod tests {
         assert_yaml_snapshot!(content);
     }
 
+    #[test]
+    fn test_save_pixi_pyproject_toml_with_python_dev_extras() {
+        let mut project_info = project_info_dummy();
+        project_info.project_manager = ProjectManager::Pixi;
+        project_info.extra_python_dev_packages = Some(vec![
+            "[email protected]".to_string(),
+            "[email protected]".to_string(),
+        ]);
+        let base = project_info.base_dir();
+        create_dir_all(&base).unwrap();
+        let expected_file = base.join("pyproject.toml");
+        save_pyproject_toml_file(&project_info).unwrap();
+
+        assert!(expected_file.is_file());
+
+        let content = std::fs::read_to_string(expected_file).unwrap();
+
+        assert_yaml_snapshot!(content);
+    }
+
     #[test]
     fn test_save_pixi_pyproject_toml_file_apache_application() {
         let mut project_info = project_info_dummy();
@@ -1821,6 +1940,26 @@ mod tests {
         assert_yaml_snapshot!(content);
     }
 
+    #[test]
+    fn test_save_pyo3_dev_requirements_extras_file() {
+        let mut project_info = project_info_dummy();
+        project_info.project_manager = ProjectManager::Maturin;
+        project_info.extra_python_dev_packages = Some(vec![
+            "[email protected]".to_string(),
+            "[email protected]".to_string(),
+        ]);
+        let base = project_info.base_dir();
+        create_dir_all(&base).unwrap();
+        let expected_file = base.join("requirements-dev.txt");
+        save_dev_requirements(&project_info).unwrap();
+
+        assert!(expected_file.is_file());
+
+        let content = std::fs::read_to_string(expected_file).unwrap();
+
+        assert_yaml_snapshot!(content);
+    }
+
     #[test]
     fn test_save_setuptools_dev_requirements_application_file() {
         let mut project_info = project_info_dummy();
@@ -1855,6 +1994,26 @@ mod tests {
         assert_yaml_snapshot!(content);
     }
 
+    #[test]
+    fn test_save_setuptools_dev_requirements_extras_file() {
+        let mut project_info = project_info_dummy();
+        project_info.project_manager = ProjectManager::Setuptools;
+        project_info.extra_python_dev_packages = Some(vec![
+            "[email protected]".to_string(),
+            "[email protected]".to_string(),
+        ]);
+        let base = project_info.base_dir();
+        create_dir_all(&base).unwrap();
+        let expected_file = base.join("requirements-dev.txt");
+        save_dev_requirements(&project_info).unwrap();
+
+        assert!(expected_file.is_file());
+
+        let content = std::fs::read_to_string(expected_file).unwrap();
+
+        assert_yaml_snapshot!(content);
+    }
+
     #[test]
     fn test_save_mkdocs_yaml() {
         let mut project_info = project_info_dummy();

src/project_info.rs

@@ -190,6 +190,7 @@ pub struct ProjectInfo {
     pub docs_info: Option<DocsInfo>,
     pub download_latest_packages: bool,
     pub extra_python_packages: Option<Vec<String>>,
+    pub extra_python_dev_packages: Option<Vec<String>>,
     pub project_root_dir: Option<PathBuf>,
 }
 
@@ -678,6 +679,12 @@ pub fn get_project_info(use_defaults: bool) -> Result<ProjectInfo> {
         use_defaults,
     )?;
 
+    let extra_python_dev_packages = default_or_prompt_option_vec_string(
+        "Extra Python Dev Dependencies".to_string(),
+        config.extra_python_dev_packages,
+        use_defaults,
+    )?;
+
     Ok(ProjectInfo {
         project_name,
         project_slug,
@@ -704,6 +711,7 @@ pub fn get_project_info(use_defaults: bool) -> Result<ProjectInfo> {
         include_docs,
         docs_info,
         extra_python_packages,
+        extra_python_dev_packages,
         download_latest_packages: false,
         project_root_dir: None,
     })

src/python_files.rs

@@ -401,6 +401,7 @@ mod tests {
             include_docs: false,
             docs_info: None,
             extra_python_packages: None,
+            extra_python_dev_packages: None,
             download_latest_packages: false,
             project_root_dir: Some(tempdir().unwrap().path().to_path_buf()),
         }