Skip to content

Commit 26d1080

Browse files
authored
docs: update README to simplify API endpoints and dev setup
Removed detailed API endpoints section and updated development environment instructions.
1 parent cb69c3c commit 26d1080

File tree

1 file changed

+16
-39
lines changed

1 file changed

+16
-39
lines changed

README.md

Lines changed: 16 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -60,25 +60,6 @@ docker compose -f dev/docker-compose.yml up --build
6060
### 5. Access the application
6161
The API will be available at [http://localhost:8001](http://localhost:8002). You can access the API documentation at [http://localhost:8001/docs](http://localhost:8002/docs).
6262

63-
## API Endpoints
64-
65-
### User Authentication
66-
- `POST /api/user/signup` - Register a new user
67-
- `POST /api/user/login` - Login and receive JWT tokens
68-
- `POST /api/user/logout` - Logout and revoke refresh token
69-
- `POST /api/user/refresh_token` - Refresh access token
70-
- `POST /api/user/check_token` - Validate access token
71-
- `POST /api/user/change_password` - Change user password
72-
- `POST /api/user/account_exists` - Check if account exists
73-
74-
### API Key Management
75-
- `POST /api/api-keys/create` - Create a new API Key (requires JWT)
76-
- `GET /api/api-keys/list` - List all API Keys for authenticated user (requires JWT)
77-
- `PATCH /api/api-keys/{key_id}/revoke` - Revoke an API Key (requires JWT)
78-
79-
### Health
80-
- `GET /health` - Service health check
81-
8263
## API Key Authentication (for services)
8364
Used by microservices for service-to-service communication:
8465

@@ -88,8 +69,9 @@ Used by microservices for service-to-service communication:
8869
curl "https://securechain.dev/api/some_endpoint" -H "X-API-Key: sk_your_api_key_here"
8970
```
9071

91-
## Python Environment
92-
The project uses Python 3.14 and the dependencies are managed with `uv` (ultra-fast Python package manager).
72+
## Development Environment
73+
74+
The project uses Python 3.14 and [uv](https://github.com/astral-sh/uv) as the package manager for faster and more reliable dependency management.
9375

9476
### Setting up the development environment using uv
9577

@@ -111,23 +93,25 @@ The project uses Python 3.14 and the dependencies are managed with `uv` (ultra-f
11193

11294
## Testing
11395

114-
### Install test dependencies
115-
116-
With uv:
11796
```bash
97+
# Install test dependencies
11898
uv sync --extra test
119-
```
12099

121-
### Run tests
122-
```bash
123100
# Run all tests
124-
uv run pytest -v
101+
uv run pytest
102+
103+
# Run tests with coverage report
104+
uv run pytest --cov=app --cov-report=term-missing --cov-report=html
105+
106+
# Run specific test file
107+
uv run pytest tests/unit/controllers/test_graph_controller.py -v
125108

126-
# Run with coverage
127-
uv run pytest --cov=app --cov-report=html
109+
# Run only unit tests
110+
uv run pytest tests/unit/ -v
128111
```
129112

130113
## Code Quality
114+
131115
```bash
132116
# Install linter
133117
uv sync --extra dev
@@ -139,16 +123,9 @@ uv run ruff check app/
139123
uv run ruff format app/
140124
```
141125

142-
### Code style
143-
This project follows:
144-
- PEP 8 style guide
145-
- Type hints for all functions
146-
- Comprehensive docstrings
147-
- Single Responsibility Principle
148-
- Dependency Injection pattern
149-
150126
## Contributing
151-
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
127+
128+
Pull requests are welcome! To contribute follow this [guidelines](https://securechaindev.github.io/contributing.html).
152129

153130
## License
154131
[GNU General Public License 3.0](https://www.gnu.org/licenses/gpl-3.0.html)

0 commit comments

Comments
 (0)