narRaters 0.1.0__tar.gz

narraters-0.1.0/.env.example

@@ -0,0 +1,7 @@
+# Hugging Face (free): sign up at https://huggingface.co/join
+# Create an access token (read): https://huggingface.co/settings/tokens
+#
+# Copy this file to .env and set your token (the real .env file is gitignored):
+#   cp .env.example .env
+#
+HF_TOKEN=

narraters-0.1.0/.gitignore

@@ -0,0 +1,86 @@
+# Local secrets (never commit)
+.env
+.env.*
+!.env.example
+
+# User authentication data (contains encrypted passwords)
+server/users.json
+manage/user_records.json
+
+# User-specific runtime state
+pipeline_config.json
+~/.narraters/
+
+# Subject data — ignore by default; whitelisted example files (pieman_edited, the_siren) are committed
+data/**
+!data/**/
+!data/**/.gitkeep
+!data/1_story_audio/pieman_edited.wav
+!data/2_story_transcript/pieman_edited.txt
+!data/2_story_transcript/the_siren.txt
+!data/3_story_events/pieman_edited_events.xlsx
+!data/3_story_events/the_siren_events.xlsx
+!data/4_recall_audio/the_siren_sub-01.mp4
+!data/4_recall_audio/the_siren_sub-02.mp4
+!data/5_recall_texts/the_siren_sub-01.txt
+!data/5_recall_texts/the_siren_sub-02.txt
+output/**
+!output/**/
+!output/**/.gitkeep
+!output/story_audio-transcribed/pieman_edited.txt
+!output/recall_audio-transcribed/the_siren_sub-01.txt
+!output/recall_audio-transcribed/the_siren_sub-02.txt
+!output/recall_corrected/the_siren_sub-01.txt
+!output/recall_corrected/the_siren_sub-02.txt
+!output/recall_parsed/the_siren_sub-01_parsed.xlsx
+!output/recall_parsed/the_siren_sub-02_parsed.xlsx
+!output/recall_rated/the_siren_sub-02_rate-recall-test_mode.xlsx
+!output/causal_rated/pieman_edited_causal-linguistic.xlsx
+!output/causal_rated/the_siren_causal-linguistic.xlsx
+
+# Python cache & build artifacts
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg-info/
+build/
+/dist/
+.pytest_cache/
+.coverage
+.ipynb_checkpoints/
+
+# Virtual environments
+venv/
+env/
+ENV/
+.venv/
+
+# IDE
+.vscode/
+.idea/
+.cursor/
+*.swp
+*.swo
+
+# Private maintainer / internal documentation (not published on GitHub)
+developer/
+
+# Coding-agent context (keep local; do not publish)
+/CLAUDE.md
+CLAUDE.local.md
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Built artifacts — regenerate on demand
+# narRater.app (rebuild: bash packaging/macos/build_app_bundle.sh)
+# narRater_Tutorial.pdf (rebuild: python generate_tutorial_pdf.py)
+# tutorial_screenshots/ (rebuild: python helpers/capture_tutorial_screenshots.py)
+tutorial_screenshots/
+narRater.app/
+narRaters_installer.app/
+# Old DMG filename (replaced by narRaters-macos-installer.dmg at repo root)
+/narRaters_installer.dmg
+narRater_Tutorial.pdf

narraters-0.1.0/LICENSE

@@ -0,0 +1,104 @@
+NarRaters Research and Non-Commercial License
+
+Copyright (c) 2026 Xian Li ("Licensor"). All rights reserved.
+
+This license governs the narRaters software and accompanying documentation
+(collectively, the "Software"). The Software was developed to support research
+and scientific work, not for commercial or for-profit exploitation.
+
+----------------------------------------------------------------------
+1. PERMITTED FREE USE (NO SEPARATE AGREEMENT REQUIRED)
+
+Subject to section 4, Licensor grants you a non-exclusive, worldwide,
+royalty-free license to use, copy, modify, merge, and distribute the Software,
+including to prepare derivative works based on the Software, solely for:
+
+  (a) Non-commercial academic, scientific, or scholarly research;
+
+  (b) Teaching, learning, or evaluation in a non-profit educational
+      institution or public research organization;
+
+  (c) Personal, non-profit, or hobby use that is not intended to generate
+      revenue or commercial advantage for you or any third party; and
+
+  (d) Use by registered charities, non-profit organizations, or government
+      entities acting in a non-commercial capacity,
+
+provided that you retain the copyright notice in section 4 and do not remove
+or alter any required notices in the Software.
+
+Uses under this section are referred to as "Permitted Non-Commercial Use."
+
+----------------------------------------------------------------------
+2. COMMERCIAL AND FOR-PROFIT USE REQUIRES WRITTEN PERMISSION
+
+Any use of the Software that is not Permitted Non-Commercial Use is not
+licensed here. Without limitation, the following require prior written
+permission from Licensor (a "Commercial License") before you may use, copy,
+modify, distribute, or offer services based on the Software:
+
+  (a) Use in connection with a business, consultancy, or other for-profit
+      activity;
+
+  (b) Use on behalf of a for-profit company or other commercial entity;
+
+  (c) Hosting, SaaS, or providing the Software (or substantial functionality
+      derived from it) to paying customers or for advertising or data-monetization
+      revenue; or
+
+  (d) Any other use primarily intended for commercial advantage or private
+      monetary compensation.
+
+To request a Commercial License, contact Licensor at the email address listed
+in the project README or repository metadata. Commercial License terms may
+include fees, royalties, revenue sharing, or other reasonable compensation
+reflecting the commercial value derived from the Software and Licensor's
+rights—consistent with the fact that the Software was offered without charge
+for research and non-profit purposes.
+
+Nothing in this license grants any right to use the Software for commercial or
+for-profit purposes without a separate written Commercial License from Licensor.
+
+----------------------------------------------------------------------
+3. RESERVATION OF RIGHTS; UNAUTHORIZED COMMERCIAL USE
+
+Except for the express rights in section 1, no license is granted under
+copyright, patent, or other intellectual property law. Licensor reserves all
+rights not expressly granted.
+
+If you use the Software outside Permitted Non-Commercial Use without a valid
+Commercial License, your use is not authorized. Licensor may pursue all remedies
+available at law or in equity, which may include injunctive relief and damages
+or other monetary recovery to the extent permitted by applicable law, including
+reasonable compensation reflecting unauthorized commercial benefit.
+
+----------------------------------------------------------------------
+4. NOTICES
+
+You must retain the above copyright notice and this license text in all copies
+or substantial portions of the Software. You must not misrepresent the origin
+of the Software.
+
+----------------------------------------------------------------------
+5. DISCLAIMER OF WARRANTY; LIMITATION OF LIABILITY
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.
+
+IN NO EVENT SHALL THE LICENSOR BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM,
+OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE, EXCEPT TO THE EXTENT LIABILITY CANNOT BE EXCLUDED OR LIMITED UNDER
+APPLICABLE LAW.
+
+----------------------------------------------------------------------
+6. GENERAL
+
+If any provision of this license is held unenforceable, the remaining
+provisions remain in effect. This license is governed by the laws applicable at
+Licensor's principal place of business, without regard to conflict-of-law
+rules, except where preempted by the laws of your jurisdiction regarding
+consumer or mandatory rights.
+
+For licensing questions, contact: xianl.cogneuro@gmail.com