You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
2 years ago | |
---|---|---|
.github | 2 years ago | |
docs | 2 years ago | |
src/doc_search | 2 years ago | |
.flake8 | 2 years ago | |
.gitignore | 2 years ago | |
.pre-commit-config.yaml | 2 years ago | |
CHANGELOG.md | 2 years ago | |
LICENCE | 2 years ago | |
Makefile | 2 years ago | |
README.md | 2 years ago | |
mkdocs.yml | 2 years ago | |
poetry.lock | 2 years ago | |
poetry.toml | 2 years ago | |
pyproject.toml | 2 years ago | |
setup.cfg | 2 years ago |
README.md
Doc Search
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.