Archives/dr-doc-search
2
0
Fork 0
mirror of https://github.com/namuan/dr-doc-search synced 2024-11-11 13:10:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
1 Commit 4 Branches 13 Tags 30 MiB
Python 92.1%
Makefile 7.9%
e01fa1708b
Go to file
namuan e01fa1708b feat: Initial commit with a skeleton project
2023-01-03 22:23:17 +00:00
.github feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
docs feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
src/doc_search feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
.flake8 feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
.gitignore feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
.pre-commit-config.yaml feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
CHANGELOG.md feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
LICENCE feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
Makefile feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
mkdocs.yml feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
poetry.lock feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
poetry.toml feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
pyproject.toml feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
README.md feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00
setup.cfg feat: Initial commit with a skeleton project 2023-01-03 22:23:17 +00:00

README.md

Doc Search

PyPI PyPI - Python Version PyPI - License

Documentation: https://namuan.github.io/dr-doc-search

Source Code: https://github.com/namuan/dr-doc-search

PyPI: https://pypi.org/project/dr-doc-search/

Search through a document using a chat interface.

Installation

pip install dr-doc-search

Example Usage

dr-doc-search --help

Development

  • Clone this repository

  • Requirements:

  • Create a virtual environment and install the dependencies

poetry install
  • Activate the virtual environment
poetry shell

Validating build

make build

Release process

A release is automatically published when a new version is bumped using make bump. See .github/workflows/build.yml for more details. Once the release is published, .github/workflows/publish.yml will automatically publish it to PyPI.