Merge pull request #14 from goldlabelapps/staging

Add .env.sample and bump version to 1.0.5

Author: goldlabelapps

.env.sample

@@ -0,0 +1,6 @@
+BASE_URL=
+DB_HOST=
+DB_PORT=5432
+DB_NAME=
+DB_USER=
+DB_PASSWORD=

README.md

@@ -1,8 +1,17 @@
-# NX AI
+## Python NX AI
 
-> FastAPI/Python/Postgres/tsvector. Production ready Python FastAPI/Postgres app for [NX](https://goldlabel.pro?s=nx-ai) AI services and more
+> FastAPI/Python/Postgres/tsvector. 
+Open Source, production ready Python FastAPI/Postgres app for [NX](https://goldlabel.pro?s=python-nx-ai)
 
-## Install & use
+#### Use
+
+`uvicorn app.main:app`
+
+#### Install
+
+Create an environment file and add Postgres credentials etc
+
+`cp .env.sample .env`
 
 ```bash
 # Create and activate a virtual environment
@@ -12,15 +21,10 @@ source venv/bin/activate   # Windows: venv\Scripts\activate
 # Install dependencies
 pip install -r requirements.txt
 
-# Start the development server
+# Start development server
 uvicorn app.main:app --reload
 ```
 
-```sh
-uvicorn app.main:app
-pytest
-```
-
 The API is at <http://localhost:8000>.
 
 [localhost](http://localhost:8000) | [Public RESTful API](https://nx-ai.onrender.com) 
@@ -33,13 +37,12 @@ The API is at <http://localhost:8000>.
 - **Pytest** — testing framework
 - **HTTPX / TestClient**
 
-
 FastAPI automatically generates interactive documentation:
 
 - Swagger UI: <http://localhost:8000/docs>
 - ReDoc: <http://localhost:8000/redoc>
 
-## Structure
+#### Structure
 
 ```
 app/
@@ -55,7 +58,7 @@ requirements.txt
 ```
 
 
-## Endpoints
+#### Endpoints
 
 | Method | Path      | Description                     |
 |--------|-----------|---------------------------------|

app/__init__.py

@@ -1,4 +1,4 @@
 """NX AI - FastAPI/Python/Postgres/tsvector"""
 
 # Current Version
-__version__ = "1.0.4"
+__version__ = "1.0.6"

requirements.txt

@@ -4,3 +4,4 @@ httpx>=0.27.0
 pytest>=8.1.0
 python-dotenv>=1.0.0
 psycopg2-binary>=2.9.0
+python-multipart>=0.0.20