Skip to content

Add .env.sample and bump version to 1.0.5 #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
goldlabelapps merged 4 commits into from
Mar 20, 2026
Merged

Add .env.sample and bump version to 1.0.5 #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
75e07c5
Add .env.sample and bump version to 1.0.5
goldlabelapps Mar 20, 2026
5be84be
Update README.md
goldlabelapps Mar 20, 2026
8142ffb
Bump version to 1.0.6
goldlabelapps Mar 20, 2026
9f20a2b
Add python-multipart to requirements
goldlabelapps Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .env.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
BASE_URL=
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BASE_URL is included in .env.sample, but there are no references to BASE_URL anywhere in the repository. Consider removing it from the sample file, or documenting where it is expected to be used (e.g., in README or upcoming code) to avoid confusing deployers about which variables are required.

Suggested change
BASE_URL=

Copilot uses AI. Check for mistakes.
DB_HOST=
DB_PORT=5432
DB_NAME=
DB_USER=
DB_PASSWORD=
27 changes: 15 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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)
Expand All @@ -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/
Expand All @@ -55,7 +58,7 @@ requirements.txt
```


## Endpoints
#### Endpoints

| Method | Path | Description |
|--------|-----------|---------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion app/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""NX AI - FastAPI/Python/Postgres/tsvector"""

# Current Version
__version__ = "1.0.4"
__version__ = "1.0.6"
1 change: 1 addition & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading