Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theextensional/knowledge-api
API django-server for repository https://github.com/TVP-Support/knowledge
https://github.com/theextensional/knowledge-api
api django firebase python
Last synced: 3 days ago
JSON representation
API django-server for repository https://github.com/TVP-Support/knowledge
- Host: GitHub
- URL: https://github.com/theextensional/knowledge-api
- Owner: theextensional
- License: gpl-3.0
- Created: 2021-12-04T23:15:15.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-14T19:59:58.000Z (over 1 year ago)
- Last Synced: 2024-03-26T11:47:09.493Z (8 months ago)
- Topics: api, django, firebase, python
- Language: Python
- Homepage: https://github.com/TVP-Support/django_knowledge/wiki
- Size: 178 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# django_knowledge
"django knowledge" - это сервер базы знаний. Призван обеспечить:
- выгрузку данных из резервного хранилища в рабочее и наоборот;
- полнотекстовый поиск по хранилищу;
- добавления
- удобные API- и GUI-инструменты для управления выгрузкой, наполнения и поиска даных из различных внешних систем. Например, чат боты, приложения для веб и смартфонов.
## Запуск
Скачивание репозитория:
```sh
git clone https://github.com/TVP-Support/django_knowledge
```
Установка зависимостей:
```sh
pip install -r requirements.txt
```
Применение миграций - инициализация базы данных django-сервера. Команда применяется при инициализации и при любом изменении:
```sh
python manage.py migrate
```
Запуск сервера:
```sh
python manage.py runserver
```
Проверка доступности сервера:
HTTP/2 200 возвращает JSON ответ.
## Импорт базы знаний
Загрузка данных из репозитория в БД.
```sh
python manage.py note_load
```
| Attribute | Type | Required | Description |
| -------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--downloader` | string | no | способ загрузки с гитхаба. Доступные значения: `github_archive` (default) извлекает текст из архива репозитория, `github_archive` загружает каждый файл из директории `db` |
| `--uploader` | string | no | Место назначения сохранения данных. Доступные значения: `django_server` (default), `firestore`, `typesense` |
Пример команды:
```sh
python manage.py note_load --downloader=github_archive --uploader=django_server
```
HTTP/2 200 возвращает JSON ответ с данными заметки `studio`.
## API сервера
[Документация API](https://github.com/TVP-Support/django_knowledge/wiki)