chore: bump version

tanloong · Aug 3, 2024 · 6328620 · 6328620
1 parent 22dda49
commit 6328620
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 30 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 <div align="center"><h1>Changelog</h1></div>
 
-## [0.1.4](https://github.com/tanloong/neosca/releases/tag/0.1.4) (3 August 2024)
+## [0.1.4](https://github.com/tanloong/neosca/releases/tag/0.1.4) (4 August 2024)
 
 ### Bug fixes
 
@@ -10,10 +10,6 @@
 
 + File Area: support drag and drop
 
-### Improvements
-
-+ Add support for dropping files/folders into the file area
-
 ## [0.1.3](https://github.com/tanloong/neosca/releases/tag/0.1.3) (25 June 2024)
 
 ### Bug fixes

diff --git a/Makefile b/Makefile
@@ -1,13 +1,13 @@
 .PHONY: build package clean install lint run test bump freeze
 
 build: clean acks
-	python3 -m build
+	python -m build
 
 package: clean acks model
-	python3 ./scripts/ns_packaging.py
+	python ./scripts/ns_packaging.py
 
 model: requirements.txt
-	python3 -m scripts.ns_download_models
+	python -m scripts.ns_download_models
 
 clean:
 	rm -rf __pycache__
@@ -33,13 +33,13 @@ lint:
 	mypy --check-untyped-defs src/
 
 test:
-	python3 -m unittest
+	python -m unittest
 
 run:
-	cd ./src && python3 -m neosca gui
+	cd ./src && python -m neosca gui
 
 acks: src/neosca/ns_data/acks.json scripts/ns_generate_acks.py
-	python3 ./scripts/ns_generate_acks.py
+	python ./scripts/ns_generate_acks.py
 
 component="patch"
 bump:
@@ -51,3 +51,9 @@ bump:
 
 freeze:
 	bash ./scripts/ns_freeze.sh
+
+sync:
+	# unlisted packages will be removed
+	uv pip sync ./requirements.txt
+	# install missing intermediate dependencies
+	uv pip install -r ./requirements.txt
diff --git a/README.md b/README.md
@@ -11,16 +11,6 @@
 
 NeoSCA is a fork of [Xiaofei Lu](http://personal.psu.edu/xxl13/index.html)'s [L2 Syntactic Complexity Analyzer](http://personal.psu.edu/xxl13/downloads/l2sca.html) (L2SCA) and [Lexical Complexity Analyzer](https://sites.psu.edu/xxl13/lca/) (LCA). Starting from version 0.1.0, NeoSCA has a graphical interface and no longer requires Java installation, it has translated a portion of the Tregex code into Python and favors Stanza over Stanford Parser.
 
-## Download
-
-|Release|Remarks|
-|-|-|
-|[Latest Release for Windows](https://github.com/tanloong/neosca/releases/download/0.1.3/NeoSCA-0.1.3-windows.zip)|1. Extract all files<br>2. Double-click **NeoSCA/NeoSCA.exe** to run|
-|[Latest Release for macOS](https://github.com/tanloong/neosca/releases/download/0.1.3/NeoSCA-0.1.3-macos.zip)|1. Extract all files<br>2. Search and open **Terminal** in Launchpad, then type `xattr -rc ` (note the trailing whitespace), drag the whole **NeoSCA** directory to the **Terminal**, and press `Enter` <br>3. Double-click **NeoSCA.app** to run|
-|[Latest Release for Arch Linux](https://github.com/tanloong/neosca/releases/download/0.1.3/NeoSCA-0.1.3-archlinux.tar.gz)|1. Extract all files<br>2. Double-click **NeoSCA/NeoSCA** to run<br>|
-|[Past Releases](https://github.com/tanloong/neosca/releases)|Not recommended|
-|[Baidu Netdisk](https://pan.baidu.com/s/1okMY3Dw20jQJtQfS6KtlYw?pwd=nsca)|For users with unstable connections to GitHub|
-
 <!-- ### Download from source -->
 <!---->
 <!-- ```sh -->
@@ -32,9 +22,28 @@ NeoSCA is a fork of [Xiaofei Lu](http://personal.psu.edu/xxl13/index.html)'s [L2
 
 ## Basic Usage
 
+### GUI
+
+Download and run the packaged application
+
+|Release|Remarks|
+|-|-|
+|[Latest Release for Windows](https://github.com/tanloong/neosca/releases/download/0.1.4/NeoSCA-0.1.4-windows.zip)|1. Extract all files<br>2. Double-click **NeoSCA/NeoSCA.exe** to run|
+|[Latest Release for macOS](https://github.com/tanloong/neosca/releases/download/0.1.4/NeoSCA-0.1.4-macos.zip)|1. Extract all files<br>2. Search and open **Terminal** in Launchpad, then type `xattr -rc ` (note the trailing whitespace), drag the whole **NeoSCA** directory to the **Terminal**, and press `Enter` <br>3. Double-click **NeoSCA.app** to run|
+|[Latest Release for Arch Linux](https://github.com/tanloong/neosca/releases/download/0.1.4/NeoSCA-0.1.4-archlinux.tar.gz)|1. Extract all files<br>2. Double-click **NeoSCA/NeoSCA** to run<br>|
+|[Past Releases](https://github.com/tanloong/neosca/releases)|Not recommended|
+|[Baidu Netdisk](https://pan.baidu.com/s/1okMY3Dw20jQJtQfS6KtlYw?pwd=nsca)|For users with unstable connections to GitHub|
+
+
 ### Command Line
 
-You can run SCA or LCA on a file/text by
+Install NeoSCA from the source code
+
+```
+pip install git+https://github.com/tanloong/neosca
+```
+
+Run SCA or LCA by
 
 ```
 python -m neosca sca filepath.txt
@@ -43,7 +52,7 @@ python -m neosca lca filepath.txt
 python -m neosca lca --text 'This is a test.'
 ```
 
-For other command line options please use
+To see other command line options please use
 
 ```
 python -m neosca --help
@@ -63,7 +72,7 @@ BibTeX
 
 ```BibTeX
 @misc{long2024neosca,
-title        = {NeoSCA: A Fork of L2 Syntactic Complexity Analyzer, version 0.1.3},
+title        = {NeoSCA: A Fork of L2 Syntactic Complexity Analyzer, version 0.1.4},
 author       = {Long Tan},
 howpublished = {\url{https://github.com/tanloong/neosca}},
 year         = {2024}
@@ -78,7 +87,7 @@ year         = {2024}
 APA (7th edition)
 </summary>
 
-<pre>Tan, L. (2024). <i>NeoSCA</i> (version 0.1.3) [Computer software]. GitHub. https://github.com/tanloong/neosca</pre>
+<pre>Tan, L. (2024). <i>NeoSCA</i> (version 0.1.4) [Computer software]. GitHub. https://github.com/tanloong/neosca</pre>
 
 </details>
 
@@ -88,7 +97,7 @@ APA (7th edition)
 MLA (9th edition)
 </summary>
 
-<pre>Tan, Long. <i>NeoSCA</i>. version 0.1.3, GitHub, 2024, https://github.com/tanloong/neosca.</pre>
+<pre>Tan, Long. <i>NeoSCA</i>. version 0.1.4, GitHub, 2024, https://github.com/tanloong/neosca.</pre>
 
 </details>
 

diff --git a/src/neosca/ns_about.py b/src/neosca/ns_about.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 __title__ = "NeoSCA"
-__version__ = "0.1.3"
+__version__ = "0.1.4"
 __author__ = "Tan, Long"
 __email__ = "[email protected]"
 __license__ = "GNU GPLv3"

diff --git a/src/neosca/ns_data/citings.json b/src/neosca/ns_data/citings.json
@@ -1,5 +1,5 @@
 {
-    "APA (7th edition)": "<p>Tan, L. (2024). <i>NeoSCA</i> (version 0.1.3) [Computer software]. GitHub. https://github.com/tanloong/neosca</p><p>Lu, X. (2010). Automatic analysis of syntactic complexity in second language writing. <i>International Journal of Corpus Linguistics, 15</i>(4), 474-496. https://doi.org/10.1075/ijcl.15.4.02lu</p><p>Lu, X. (2012). The relationship of lexical richness to the quality of ESL learners' oral narratives. <i>The Modern Language Journal, 96</i>(2), 190-208. https://doi.org/10.1111/j.1540-4781.2011.01232_1.x</p>",
-    "MLA (9th edition)": "<p>Tan, Long. <i>NeoSCA</i>. version 0.1.3, GitHub, 2024, https://github.com/tanloong/neosca.</p><p>Lu, Xiaofei. \"Automatic Analysis of Syntactic Complexity in Second Language Writing.\" <i>International Journal of Corpus Linguistics</i>, vol. 15, no. 4, John Benjamins Publishing Company, 2010, pp. 474-96, https://doi.org/10.1075/ijcl.15.4.02lu.</p><p>Lu, Xiaofei. \"The Relationship of Lexical Richness to the Quality of ESL Learners' Oral Narratives.\" <i>The Modern Language Journal</i>, vol. 96, no. 2, Wiley-Blackwell, 2012, pp. 190-208, https://doi.org/10.1111/j.1540-4781.2011.01232_1.x.</p>",
-    "BibTeX": "@misc{long2024neosca,\ntitle = {NeoSCA: A Fork of L2 Syntactic Complexity Analyzer, version 0.1.3},\nauthor = {Long Tan},\nhowpublished = {\\url{https://github.com/tanloong/neosca}},\nyear = {2024}\n}\n\n@article{xiaofei2010automatic,\ntitle = {Automatic analysis of syntactic complexity in second language writing},\nauthor = {Xiaofei Lu},\njournal = {International journal of corpus linguistics},\nvolume = {15},\nnumber = {4},\npages = {474--496},\nyear = {2010},\npublisher = {John Benjamins Publishing Company},\ndoi = {10.1075/ijcl.15.4.02lu},\n}\n\n@article{xiaofei2012relationship,\nauthor = {Xiaofei Lu},\ntitle = {The Relationship of Lexical Richness to the Quality of ESL Learners' Oral Narratives},\njournal = {The Modern Language Journal},\nvolume = {96},\nnumber = {2},\npages = {190-208},\ndoi = {https://doi.org/10.1111/j.1540-4781.2011.01232_1.x},\nyear = {2012}\n}"
+    "APA (7th edition)": "<p>Tan, L. (2024). <i>NeoSCA</i> (version 0.1.4) [Computer software]. GitHub. https://github.com/tanloong/neosca</p><p>Lu, X. (2010). Automatic analysis of syntactic complexity in second language writing. <i>International Journal of Corpus Linguistics, 15</i>(4), 474-496. https://doi.org/10.1075/ijcl.15.4.02lu</p><p>Lu, X. (2012). The relationship of lexical richness to the quality of ESL learners' oral narratives. <i>The Modern Language Journal, 96</i>(2), 190-208. https://doi.org/10.1111/j.1540-4781.2011.01232_1.x</p>",
+    "MLA (9th edition)": "<p>Tan, Long. <i>NeoSCA</i>. version 0.1.4, GitHub, 2024, https://github.com/tanloong/neosca.</p><p>Lu, Xiaofei. \"Automatic Analysis of Syntactic Complexity in Second Language Writing.\" <i>International Journal of Corpus Linguistics</i>, vol. 15, no. 4, John Benjamins Publishing Company, 2010, pp. 474-96, https://doi.org/10.1075/ijcl.15.4.02lu.</p><p>Lu, Xiaofei. \"The Relationship of Lexical Richness to the Quality of ESL Learners' Oral Narratives.\" <i>The Modern Language Journal</i>, vol. 96, no. 2, Wiley-Blackwell, 2012, pp. 190-208, https://doi.org/10.1111/j.1540-4781.2011.01232_1.x.</p>",
+    "BibTeX": "@misc{long2024neosca,\ntitle = {NeoSCA: A Fork of L2 Syntactic Complexity Analyzer, version 0.1.4},\nauthor = {Long Tan},\nhowpublished = {\\url{https://github.com/tanloong/neosca}},\nyear = {2024}\n}\n\n@article{xiaofei2010automatic,\ntitle = {Automatic analysis of syntactic complexity in second language writing},\nauthor = {Xiaofei Lu},\njournal = {International journal of corpus linguistics},\nvolume = {15},\nnumber = {4},\npages = {474--496},\nyear = {2010},\npublisher = {John Benjamins Publishing Company},\ndoi = {10.1075/ijcl.15.4.02lu},\n}\n\n@article{xiaofei2012relationship,\nauthor = {Xiaofei Lu},\ntitle = {The Relationship of Lexical Richness to the Quality of ESL Learners' Oral Narratives},\njournal = {The Modern Language Journal},\nvolume = {96},\nnumber = {2},\npages = {190-208},\ndoi = {https://doi.org/10.1111/j.1540-4781.2011.01232_1.x},\nyear = {2012}\n}"
 }