Merge pull request #20 from Materials-Data-Science-and-Informatics/custom-cli

Refactor to use a custom CLI tool to enable more flexibility, add better GitLab support

Author: apirogov

.gitignore

@@ -1,3 +1,6 @@
+temp/
+scratch/
+
 # don't add vscode stuff
 .vscode
 

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-exclude: "^{{ cookiecutter.*"  # <-- added
+exclude: "src/fair_python_cookiecutter/template/*"  # <-- added
 # ---- copy from template below ----
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
@@ -26,12 +26,6 @@ repos:
         args: [--no-strict-optional, --ignore-missing-imports]
         # NOTE: you might need to add some deps here:
         additional_dependencies: []
-  - repo: https://github.com/PyCQA/bandit
-    rev: '1.7.5'
-    hooks:
-    - id: bandit
-      args: ['-q', '-c', 'pyproject.toml']
-      additional_dependencies: [ '.[toml]' ]
 
   # Metadata
   - repo: https://github.com/citation-file-format/cff-converter-python
@@ -44,7 +38,7 @@ repos:
       - id: reuse
 
   - repo: https://github.com/Materials-Data-Science-and-Informatics/somesy
-    rev: 'v0.2.0'
+    rev: 'v0.2.1'
     hooks:
       - id: somesy
 

.somesy.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fair-python-cookiecutter"
-version = "0.1.0"
+version = "0.2.0"
 description = "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata. "
 
 license = "MIT"

CHANGELOG.md

@@ -4,6 +4,10 @@ Here we provide notes that summarize the most important changes in each released
 
 Please consult the changelog to inform yourself about breaking changes and security issues.
 
+## [v0.2.0](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter/tree/v0.2.0) <small>(2024-01-05)</small> { id="0.2.0" }
+
+* Refactored into custom tool `fair-python-cookiecutter` for more versatility and convenience
+
 ## [v0.1.0](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter/tree/v0.1.0) <small>(2023-07-24)</small> { id="0.1.0" }
 
 * First release

CITATION.cff

@@ -3,7 +3,7 @@ type: software
 message: If you use this software, please cite it using this metadata.
 
 title: "fair-python-cookiecutter"
-version: "0.1.0"
+version: "0.2.0"
 abstract: "An opinionated cookiecutter template to kickstart a modern best-practice
   Python project with FAIR metadata."
 repository-code: "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter"

CODE_OF_CONDUCT.md

@@ -1 +1 @@
-{{ cookiecutter.__project_slug }}/CODE_OF_CONDUCT.md
+src/fair_python_cookiecutter/template/{{ cookiecutter.project_slug }}/CODE_OF_CONDUCT.md

CONTRIBUTING.md

@@ -1 +1 @@
-{{ cookiecutter.__project_slug }}/CONTRIBUTING.md
+src/fair_python_cookiecutter/template/{{ cookiecutter.project_slug }}/CONTRIBUTING.md

README.md

@@ -6,16 +6,25 @@
 ](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter/actions/workflows/ci.yml)
 
 <!-- --8<-- [start:abstract] -->
+
+<br />
+<div>
+<img style="center-align: middle;" alt="FAIR Python Cookiecutter Logo" src="https://raw.githubusercontent.com/Materials-Data-Science-and-Informatics/Logos/main/FAIRPythonCookiecutter/FAIRPYTHONCOOKIECUTTER_Logo_Text.png" width=70% height=70% />
+&nbsp;&nbsp;
+</div>
+<br />
+
 # fair-python-cookiecutter
 
 An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata.
 
 <!-- NOTE: For technical reasons, it is much easier to use GitHub
      for hosting the mindmap than adding it to the repository -->
-![FAIR Software Mindmap](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter/assets/371708/1eba8eaf-663f-4475-b6ce-39fac1a183b5)
+![FAIR Software Mindmap](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter/assets/371708/ef566ee1-8965-4d58-9ede-18eeb49a476e)
 
-*Check out a demo repository generated from this template
-:point_right: [here](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo)*
+*Check out the
+[demo repository](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo)
+generated from this template!*
 
 ## Overview
 
@@ -77,27 +86,37 @@ recommendations on the state of software citation in academic practice.
 
 ## Getting Started
 
-First, make sure that you have a recent version of
-[cookiecutter](https://www.cookiecutter.io/) (`cookiecutter>=2.1`).
-This template does not work with older versions, because they lack some needed features.
+To install the template, run `pip install fair-python-cookiecutter`.
 
-To install `cookiecutter`, you can run `pip install cookiecutter`.
-
-To generate a new Python project from this template, run:
+Now you can run the tool to generate a new Python project:
 
 ```bash
-cookiecutter https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter
+fair-python-cookiecutter YourProjectName
 ```
 
-This will spawn an interactive prompt, where you have to provide some information and select
-a starting skeleton for your software project. Don't worry, you can always adapt this
-information later on by hand. After this cookiecutter will initate your software project.
+This will spawn an interactive prompt, where you have to provide some information and
+make some choices for your new software project. Don't worry, you can always adapt
+everything later on by hand. After this, your software project will be created in
+a new directory.
+
+To save you some time answering the questions, we recommend that you create an empty repository
+in GitHub or GitLab of your choice (i.e., the location where you plan to push your new project).
+
+If you already have created an empty remote repository or know exactly its future
+location, you can provide the URL, which already will provide many required inputs:
+
+```bash
+fair-python-cookiecutter --repo-url https://github.com/YourOrganization/YourProjectName
+```
 
 Your new project repository will also include a copy of a
 [developer guide](https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter-demo/latest/dev_guide),
 containing more information about the structure and features of the generated project.
-Feel free to either remove it, or keep (and possibly adjust) it as extended technical
-project documentation for yourself and other future project contributors.
+
+**Please familiarize yourself with the generated structures, files and the contents of the
+developer guide.** Feel free to either remove the guide afterwards, or keep (and possibly
+adjust) it as extended technical project documentation for yourself and other future
+project contributors.
 
 You can find a demo repository generated from this template [here](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo).
 
@@ -109,15 +128,15 @@ you might want to configure some template variables in your `~/.cookiecutterrc`.
 Here is an example cookiecutter configuration:
 
 ```yaml
-default_context:
-  __org_name: "Your Institution"
-  __org_mail_suffix: "your-institution.org"
-  __org_rep: "Your Boss <your.boss@your-institution.org>"
-  __org_gh: "Your-Github-Organization"
-
-  author_last_name: "Lastname"
-  author_first_name: "Firstname"
-  author_orcid: "0000-0000-1234-5678"
+fair_python_cookiecutter:
+  last_name: "Carberry"
+  first_name: "Josiah"
+  project_keywords: "psychoceramics analytics"
+  email: "josiah.carberry@brown.edu"
+  orcid: "0000-0002-1825-0097"
+  affiliation: "Brown University"
+  copyright_holder: "Brown University"
+  license: "MIT"
 ```
 
 This information will be already pre-filled when you use the template,
@@ -132,8 +151,9 @@ it to get your own copy. Then you can do the desired changes and use the URL of
 template repository instead of this one to kickstart your projects.
 
 However, if you think that your changes are of general interest and would improve this
-template, consider to get in touch
-and [contribute](https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter/main/contributing/)!
+template for a majority of users, please get in touch
+and [contribute](https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter/main/contributing/)
+or [suggest](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter/issues) an improvement!
 
 In any case we are very happy to know about any similar or derivative templates, e.g. for
 more specific use-cases or based on other tool preferences.
@@ -148,7 +168,7 @@ from this template, there are two main ways to do so:
 
 If your project currently has no sophisticated setup of tools or strong preferences about
 them, option 1 might be the simplest way to adopt the template. Your code then needs to be
-moved into the `YOUR_PROJECT/src` subdirectory.
+moved into the `YOUR_PROJECT/src/YOUR_PACKAGE` subdirectory.
 
 On the other hand, if you already have a working setup that you do not wish to replace
 completely, you can take a look at

codemeta.json

@@ -57,26 +57,61 @@
             "runtimePlatform": "Python 3",
             "version": "^2.1.1"
         },
+        {
+            "@type": "SoftwareApplication",
+            "identifier": "importlib-resources",
+            "name": "importlib-resources",
+            "runtimePlatform": "Python 3",
+            "version": "^6.1.1"
+        },
+        {
+            "@type": "SoftwareApplication",
+            "identifier": "platformdirs",
+            "name": "platformdirs",
+            "runtimePlatform": "Python 3",
+            "version": "^4.1.0"
+        },
         {
             "@type": "SoftwareApplication",
             "identifier": "pydantic",
             "name": "pydantic",
             "runtimePlatform": "Python 3",
             "version": "^2.5.2"
         },
+        {
+            "@type": "SoftwareApplication",
+            "identifier": "pydantic-yaml",
+            "name": "pydantic-yaml",
+            "runtimePlatform": "Python 3",
+            "version": "^1.2.0"
+        },
         {
             "@type": "SoftwareApplication",
             "identifier": "python",
             "name": "python",
             "runtimePlatform": "Python 3",
             "version": "^3.8"
         },
+        {
+            "@type": "SoftwareApplication",
+            "identifier": "spdx-lookup",
+            "name": "spdx-lookup",
+            "runtimePlatform": "Python 3",
+            "version": "^0.3.3"
+        },
         {
             "@type": "SoftwareApplication",
             "identifier": "typer",
             "name": "typer",
             "runtimePlatform": "Python 3",
             "version": "^0.9.0"
+        },
+        {
+            "@type": "SoftwareApplication",
+            "identifier": "typing-extensions",
+            "name": "typing-extensions",
+            "runtimePlatform": "Python 3",
+            "version": "^4.8.0"
         }
     ],
     "targetProduct": {
@@ -86,5 +121,5 @@
         "runtimePlatform": "Python 3"
     },
     "url": "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter",
-    "version": "0.1.0"
+    "version": "0.2.0"
 }