atila-atlas 0.0.1

Atlas is a search engine for parsing a collection of web pages and making it searchable.

Atlas

Atlas is a search engine for parsing a collection of web pages and making it searchable.

Atlas stands for Atila's Tool for Learning any Subject. We're starting by focusing on web3 and crypto related content with plans to add other subjects in the future. However, you're welcome to use Atlas to index and search any type of content you want.

Installation

pip install atila-atlas

Development Installation

source install.sh
pip install -e .

Quickstart

atlas initialize_index
atlas add_content --file data/urls_to_parse.txt
atlas add_content --urls https://ethereum.org/en/nft,https://en.wikipedia.org/wiki/Ethereum
atlas query "what is an nft"
atlas get_inbound_links --min-inbound-links=2

Development Quickstart

Note: Make sure you've put your environment variables into the newly created .env file that was taken from shared.env

# 1. Parse and index your content:
python atlas/content_parser.py

# 2. Initialize your content:
python atlas/content_index.py

# 3. Run the API
python api/api.py

# 4. Send a GET request to your api
curl --location --request GET 'http://127.0.0.1:8080/api/search?q=what+is+an+NFT'
# or open your browser to `http://127.0.0.1:8080/api/search?q=<your_search_term>` 

Publishing Package to PyPi

1. python -m build
2. Uploading to test PYPi server first to practice:
3. python -m twine upload --repository testpypi dist/*
   1. Note the use of no-dependencies flag: --no-deps. This is because the dependencies might not be in the TestPyPi
   2. Set your username to token
   3. Set your password to the token value, including the pypi- prefix
4. Upload to the real PyPI server:

Troubleshooting

ModuleNotFoundError: No module named 'atlas'

Set your $PYTHONPATH. See this [SO answer](ModuleNotFoundError: No module named 'atlas')