From dadaf685f94576f84743e84325c615c66fb3466d Mon Sep 17 00:00:00 2001 From: Will Riley Date: Tue, 17 Jun 2025 02:35:46 +0200 Subject: [PATCH] Updated brief description. --- CITATION.cff | 2 +- README.md | 6 ++++-- pyproject.toml | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 56f1d69..012aa15 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -12,7 +12,7 @@ authors: repository-code: >- https://github.com/willynilly/parsnips abstract: >- - Create SWHIDs for Python classes, functions, and other source code fragments based on its abstract syntax tree. + Generate, search, and cite SWHIDs for Python code fragments like classes, functions, and expressions. keywords: - SWHID - Software Heritage diff --git a/README.md b/README.md index b2507be..5676917 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ # Parsnips -Create SWHIDs for Python classes, functions, and other source code fragments based on their abstract syntax tree (AST). +Generate, search, and cite SWHIDs for Python code fragments like classes, functions, and expressions. ## Overview -**Parsnips** is a Python tool that analyzes Python source files using the built-in `ast` module and `asttokens` to create fine-grained, reproducible identifiers for fragments of Python code. It is designed to support persistent software identifiers (SWHIDs) for structural code elements such as: +**Parsnips** is a Python tool that analyzes source files to create a citable hierarchy of folders and metadata files representing nodes in a parsed abstract syntax tree (AST). AST nodes correspond to meaningful code fragments such as classes, functions, and expressions. The metadata files and folders can be stored in your repository. If you archive your repository on Software Heritage, you can then retrieve and cite the SWHIDs for these fragments. + +Parsnips uses the built-in `ast` module and `asttokens` to create fine-grained, reproducible identifiers for fragments of Python code. It is designed to support persistent software identifiers (SWHIDs) for structural code elements such as: - Functions - Classes diff --git a/pyproject.toml b/pyproject.toml index f26f26c..ebd14c7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "hatchling.build" [project] name = "parsnips" version = "2.0.1" -description = "Create SWHIDs for Python classes, functions, and other source code fragments based on its abstract syntax tree." +description = "Generate, search, and cite SWHIDs for Python code fragments like classes, functions, and expressions." readme = "README.md" requires-python = ">=3.12" license = "Apache-2.0"