Orchard PeARS
What and why
PeARS (version Orchard) is a search engine that you can install and run locally from your browser. It allows you to 'index' pages (i.e. to produce a computer-readable representation of the pages' content, essential to the search process), and to search pages that you or your friends have indexed. Search happens entirely on your machine, meaning that no one knows what you are searching and when.
One feature of PeARS Orchard is the ability to convert a small index into a greyish, unassuming picture, called a 'snow pod'. Snow pods are the mini-weapons of the indexing revolution. They can easily be shared with others by email, on social media, or through any other means, so you can be your very own search engine, for yourself and for your friends.
How does this fit with peer-to-peer PeARS?
The fully-fledged PeARS system (Peer-to-peer Agent for Reciprocated Search) is supposed to be completely distributed. You can imagine it as an 'automated' version of Phase 1, where you don't have to go and hunt for pods yourself. Your PeARS install will automatically find them on other users' systems and connect to them. We are still working on this phase of the project.
Usage
NB: we have some instructions for Windows users on the wiki.
1. Clone this repo on your machine:
git clone https://github.com/PeARSearch/PeARS-orchard.git
2. Optional step Setup a virtualenv in your directory.
If you haven't yet set up virtualenv on your machine, please install it via pip:
sudo apt-get update
sudo apt-get install python3-setuptools
sudo apt-get install python3-pip
sudo pip3 install virtualenv
Then run:
virtualenv -p python3 env && source env/bin/activate
Then change into the PeARS-orchard directory:
cd PeARS-orchard
3. Install the build dependencies:
pip3 install -r requirements.txt
4. Unpack the semantic space
Head over to the app/static/spaces directory and unzip english.dm.zip.
cd app/static/spaces
unzip english.dm.zip
5. Run it!
In the root of the repo, run:
python3 run.py
Now, go to your browser at localhost:8080. You should see the search page for PeARS. You don't have any pages indexed yet, so go to the F.A.Q. page (link at the top of the page) and follow the short instructions to get you going!
Metadata
Release files for pears-orchard 0.0.16
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pears_orchard-0.0.16.tar.gz | 17.1 kB | Without provenance | Details for pears_orchard-0.0.16.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pears_orchard-0.0.16-py3-none-any.whl | Python 3 | none | any | Details for pears_orchard-0.0.16-py3-none-any.whl |
Total release size: 51.4 kB
Release files / pears_orchard-0.0.16.tar.gz
| Download URL | pears_orchard-0.0.16.tar.gz |
|---|---|
| Size | 17.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6b9be48182874dc14c735bf35ef44a71654bff77729221457ea6dd8b5fe5e590
|
|
BLAKE2b-256 checksum How to use checksums |
0ee675fcbcfba13fc3eb10ab4d752c4648cb215e558a4ab6c81cb161061cf342
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.0
|
Release files / pears_orchard-0.0.16-py3-none-any.whl
| Download URL | pears_orchard-0.0.16-py3-none-any.whl |
|---|---|
| Size | 34.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ef3913733b9d75c3177f562064cbd4fbee3449b8e172d4a98f6308577bd12586
|
|
BLAKE2b-256 checksum How to use checksums |
bd3b293fe5447801a51f8750d79d82e3560f55016fe89e9cda7b6fbac84adf06
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.0
|
Security for pears-orchard 0.0.16
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.