/cryptoscrape

Scrape popular forums and image boards for mentions of crypto-currencies, and perform sentiment analysis

Primary LanguagePythonMIT LicenseMIT

cryptoscrape

This is cryptoscrape, a simple webscraper designed to get information on various crypto-currencies from popular online forums and imageboards.

Why?

cryptoscrape is designed as a tool to be used in conjunction with other projects. By harnessing the power of cryptoscrape, one can easily compare mentions and other metrics of popularity between different crypto-currencies.

These metrics are written to a SQLite database (cryptos.db) for easy accessibility and manipulation.

Roadmap

  1. Fix how new data is pulled by date
  2. Track down the source of SQL issues...

Features

As of right now, cryptoscrape only works with reddit. Read below to see how to configure reddit scraping.

Configuration

Each source has its own folder within the sources directory. Inside each source's folder are three text files: info.txt, included.txt , and cryptos.txt with info.txt holding information on setting up that particular source.

Additionally, you must set up an app here and enter all relevant information into the praw.ini file before scraping. A username and password are not required in the praw.ini and it is therefore highly recommended that you do not include those: this will reduce the likelihood this information is accidentally uploaded (see following note).

Note: if you are pushing your own version of this project to a Git repository, please ensure that you are not pushing your praw.ini file, as it will contain your personal information. See here for information on ignoring changes to the file, so it will not be uploaded.

Usage

As of right now, this project is not incredibly user-friendly. You must be running Python > v2.5 and have PRAW and TextBlob installed in order for this to run properly. This now uses command-line arguments to handle the post limit. See usage below.

To run:

git clone https://github.com/bdscharf/cryptoscrape.git

git submodule init

git submodule update

cd cryptoscrape

python run.py [post-limit]

Applications

Applications of crypto-scrape will be linked here.

License

MIT License

Copyright (c) 2017 Benjamin Scharf

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.