https://github.com/defrecord/literate-spacy
A literate programming implementation of a spaCy-based NLP tool using Org mode
https://github.com/defrecord/literate-spacy
fastapi literate-programming nlp org-mode python spacy
Last synced: about 1 year ago
JSON representation
A literate programming implementation of a spaCy-based NLP tool using Org mode
- Host: GitHub
- URL: https://github.com/defrecord/literate-spacy
- Owner: defrecord
- Created: 2025-03-20T16:37:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-20T18:15:10.000Z (about 1 year ago)
- Last Synced: 2025-03-20T18:22:22.673Z (about 1 year ago)
- Topics: fastapi, literate-programming, nlp, org-mode, python, spacy
- Language: Makefile
- Size: 14.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.org
Awesome Lists containing this project
README
#+TITLE: Literate-spaCy
#+AUTHOR: Claude
* Overview
A literate programming implementation of a spaCy-based NLP tool using Org mode.
* Development Workflow
** Important Note on Making Changes
This project follows literate programming principles using Org mode. The main source file is =spacy-nlp-tool.org=, not the Python files in the repository.
*If you need to make changes*:
1. Edit the =spacy-nlp-tool.org= file
2. After making changes, run the detangle command to update the code files:
#+begin_src emacs-lisp
M-x org-babel-detangle
#+end_src
Or programmatically:
#+begin_src emacs-lisp
(org-babel-detangle &optional SOURCE-CODE-FILE)
#+end_src
** Never Edit Generated Files Directly
The Python files in =src/= and =scripts/= directories are generated from the Org file. Any direct edits to these files will be lost when the Org file is detangled.
* Getting Started
See =CLAUDE.org= for all build, setup, and testing commands.
* Project Structure
- =spacy-nlp-tool.org= - Main literate programming source file
- =src/= - Generated Python code
- =client/= - API client implementation
- =model/= - spaCy processing functionality
- =server/= - FastAPI server implementation
- =scripts/= - Utility scripts