semvec/pypi-packages huggingface dataset:
django-embeddings 1.0.0
A Django application for embeddings
License: MIT License
Requires Python: >=3.8

# Django Embeddings

## Installation

```bash
pip install django-embeddings
```

## Usage

Add `django_embeddings` to your `INSTALLED_APPS` in `settings.py`:

```python
INSTALLED_APPS = [
    # ...existing apps...
    'django_embeddings',
]
```

## Settings

Configure any necessary settings in `settings.py`:

```python
DJANGO_EMBEDDINGS_SETTING = 'value'
```

## Examples

```python
# Example usage of the app
```

## Using the Similar Pages API

To use the similar-pages API, follow these steps:

1. Start the Django server:
    ```sh
    docker-compose up
    ```

2. Open your browser and navigate to `http://localhost:8000/similar-pages/`.

3. Enter a URL in the input field and click the "Search" button to find similar pages.

The API endpoint for similar pages is available at:
```
GET /api/v1/similar-pages/?url=<URL>
```

Example:
```
GET http://localhost:8000/api/v1/similar-pages/?url=https://www.example.com/
```

This will return a JSON response with a list of similar pages and their details.

## Running Tests

Run the tests using Django's test framework:
```sh
python manage.py test django_embeddings
```
````