Archives
/
dr-doc-search
mirror of https://github.com/namuan/dr-doc-search
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
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.
32 Commits
4 Branches
13 Tags
30 MiB
Python 92.1%
Makefile 7.9%
 
 
chore/update-dependencies
gh-pages
main
doc-sources
0.0.0
0.10.0
1.0.1
1.1.0
1.2.0
1.3.0
1.4.0
1.4.1
1.5.0
1.5.1
1.6.0
1.6.2
1.6.3
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c13e4c9ec6'
${ noResults }
Go to file
namuan c13e4c9ec6 bump: version 1.0.1 → 1.1.0 1 year ago
.github ci: Run tests w/ Python 3.10 1 year ago
docs feat: Initial commit with a skeleton project 1 year ago
src/doc_search feat: #2 Provide option to just create a model for provided book 1 year ago
tests feat: #2 Provide option to just create a model for provided book 1 year ago
.flake8 feat: Initial commit with a skeleton project 1 year ago
.gitignore feat: Add steps to convert pdf file to scanned pages of text 1 year ago
.pre-commit-config.yaml build: Better to see all errors at once 1 year ago
CHANGELOG.md bump: version 1.0.1 → 1.1.0 1 year ago
LICENCE feat: Initial commit with a skeleton project 1 year ago
Makefile docs: Update README to remove dependency which is not necessary for running the application 1 year ago
README.md docs: Update dependencies 1 year ago
mkdocs.yml feat: Initial commit with a skeleton project 1 year ago
poetry.lock feat: #2 Provide option to just create a model for provided book 1 year ago
poetry.toml feat: Initial commit with a skeleton project 1 year ago
pyproject.toml bump: version 1.0.1 → 1.1.0 1 year ago
setup.cfg feat: Initial commit with a skeleton project 1 year ago

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/

Converse with an ebook (PDF)

Pre-requisites

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.