Skip to content

A minimal python search engine for productivity that stores documents as code

License

Notifications You must be signed in to change notification settings

jeanCarloMachado/PythonSearch

Repository files navigation

PythonSearch

Python search is a minimal search engine writting in python for developers productivity. With PythoSearch you collect and retrieve and refactor information efficiently.

  • collect commands, scripts, prompts, snippets, urls, files, efficiently as python dictionaries
  • retrieve or execute the registered entries (depending on the type) either by searching them or invoking them via shortcuts
  • refactor, reuse, generate and further automate entries as they are code

Check out these slides if you want to know more

For an example of how an entries could look like see here.

Minimal installation

This installation covers the minimun functionality of Python search. Write a python script like this, and call it.

1. Install python search

pip install python-search && python_search install_missing_dependencies

Note that you might need to upgrade your pip first: pip install --upgrade pip

To access the CLI manual and understand the options run:

python_search

Everything in python search you do through the cli tool.

We support Mac and Linux.

If you want to develop python-search install it via the instructions in the contributing doc

2. Initialize your entries project

python_search new_project "MyEntries"

It will create a new git project for you for your entries.

3. Using

Done! You can run the search UI by running.

python_search search

Read our documentaiton here for more in depth knwoledge.

Got an issue?

Create a github issue to report it or send a patch.

Contributing

Feature contributions are also welcomed! If you want to be part of the roadmap discussions reach out.

Contributors

  • Aeneas Christodoulou
  • Jean Machado
  • Thallys Costa

Supported Systems

PythonSearch officially supports MacOS and Linux.

Legal

This project is licensed under the Apache License, Version 2.0. See LICENSE for the full text.
Copyright 2022 Jean Carlo Machado

See also our website

About

A minimal python search engine for productivity that stores documents as code

Topics

Resources

License

Stars

Watchers

Forks

Languages