From 5150dfcb76d2af0c97a676f28f0b988dde4ee4ed Mon Sep 17 00:00:00 2001 From: Daniel Date: Tue, 6 Aug 2024 10:34:07 -0700 Subject: [PATCH 1/2] docs: update documentation --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2fc6d46..42be1ce 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,13 @@ ![CI](https://github.com/unlv-evol/PyReprism/actions/workflows/ci.yml/badge.svg) ![Publish](https://github.com/unlv-evol/PyReprism/actions/workflows/publish.yml/badge.svg) [![codecov](https://codecov.io/gh/unlv-evol/PyReprism/graph/badge.svg?token=J2JV31837H)](https://codecov.io/gh/unlv-evol/PyReprism) +![PyPI - Version](https://img.shields.io/pypi/v/pyreprism) +![GitHub last commit (branch)](https://img.shields.io/github/last-commit/unlv-evol/pyreprism/main) + # PyReprism -PyReprism is a suite of essential methods designed for common preprocessing tasks in code clone detection research. +PyReprism is a Python framework that helps researchers and developers the task of source code preprocessing. With PyReprism, you can easily match, extract, count, and remove comments, whitespaces, operators, numbers and other language specific constructs from over **150 programming languages and file extensions**. ## Install ```shell From 6d1441da7a0a95696f1684ac5d25b95e96df1552 Mon Sep 17 00:00:00 2001 From: Daniel Date: Tue, 6 Aug 2024 10:34:42 -0700 Subject: [PATCH 2/2] docs: update documentation --- docs/intro.rst | 2 +- pyproject.toml | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/intro.rst b/docs/intro.rst index 20710f7..c055ea4 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -4,7 +4,7 @@ Overview / Install ================== -PyReprism is a Python framework that helps researchers and developers the task of source code preprocessing. With PyReprism, you can easily match, extract, count, and remove comments, whitespaces, operators, numbers and other language specific constructs from over 150 programming languages and file extension. +PyReprism is a Python framework that helps researchers and developers the task of source code preprocessing. With PyReprism, you can easily match, extract, count, and remove comments, whitespaces, operators, numbers and other language specific constructs from over 150 programming languages and file extensions. Requirements diff --git a/pyproject.toml b/pyproject.toml index f9e7c3a..ffd715b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,11 +12,11 @@ authors = [ license={file="LICENSE" } python_requires = ">=3.5" description = "Framework for Source Code Preprocessing" -readme = "README.md" +readme = "PyReprism is a Python framework that helps researchers and developers the task of source code preprocessing. With PyReprism, you can easily match, extract, count, and remove comments, whitespaces, operators, numbers and other language specific constructs from over 150 programming languages and file extensions." requires-python = ">=3.6" classifiers = [ "Environment :: Console", - "Development Status :: 4 - Beta", + "Development Status :: 5 - Stable, "Intended Audience :: Developers", "Intended Audience :: Science/Research", "Programming Language :: Python :: 3", @@ -43,4 +43,5 @@ dev = [ [project.urls] Homepage = "https://github.com/unlv-evol/PyReprism" +Documentation = "https://pyreprism.readthedocs.io" Issues = "https://github.com/unlv-evol/PyReprism/issues" \ No newline at end of file