innocuous-symmetry/python-node-pdf-reader
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Create README.md

Browse Source
This commit is contained in:
Mikayla Dobson
2022-04-26 14:10:19 -05:00
committed by GitHub
parent b7b52901e6
commit 6b5083731d
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md Normal file
View File

@@ -0,0 +1,9 @@
# python-node-pdf-reader
A simple Node interface with a locally hosted server; allows the user to convert PDF files to text using Python and query from a list of these files with a basic Express server.
## Local deployment
1. From within the project directory, run ```node app.js``` to start the Express server.
2. The Python logic will be automatically triggered while this server is active.
3. The ```/pdf-gen/``` endpoint allows you to provide a href within the project folder "recipes" from which to extract text.
4. Expects the URL format ```{localhost}/url-gen?href={your path}```
5. The ```/pdfs/:name``` endpoint allows you to search your files for a .txt file of a certain name. A preview excerpt of 150 characters is then sent as a response.