Inspired by Vannevar Bush's fictional device that would be a digital searchable record of our lives.
Mainly this memex will be able to store and archive pages on the internet so we can recall them quickly.
NOTE: This project is still in development.
Memex uses the poetry package manager. Please install using the directions from their website before continuing
$ git clone https://github.com/nathanielCherian/memex
$ cd memex && poetry install
$ poetry shell
This will activate the poetry virtual enviornment
On running memex for the first time, a configuration file will be created at ~/.memex.
$ memex file [url?] [keywords?]
Stores a new entry to the database. keywords are space-seperated.
$ memex list
Shows all entrys in the database
$ memex search [keywords]
Returns entries that match one or more of the keywords given. Keywords are space-seperated
$ memex inspect [id]
Displays full entry of given id.
Memex also comes with an API that allows remote access to the database.
$ memex-api create [token-name?]
Creates a new authorization token.
$ memex-api list
Lists valid tokens
$ memex-api revoke [token-id]
Revokes authorizaiton token.
$ memex-api start
Starts the API
Plugins...
Tests include both memex and the memex-api. Make sure the api is active before running tests.
$ poetry run pytest
- Lightweight
- Doesn't need to do everything
- Simple to use (shouldn't take more than 10 seconds to add an entry)
- Modular
- The user should be able to choose how they want to expand their memex
- Modularality through extensions allows bare-minimum functionality or over the top features
- Secure
- Privacy
- Prevent Data loss