Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nmapx/revolut-stocks-list
Extract Revolut stocks list from the list screenshot(s).
https://github.com/nmapx/revolut-stocks-list
extract image list ocr revolut screenshot stocks tesseract
Last synced: 2 months ago
JSON representation
Extract Revolut stocks list from the list screenshot(s).
- Host: GitHub
- URL: https://github.com/nmapx/revolut-stocks-list
- Owner: nmapx
- License: mit
- Archived: true
- Created: 2020-01-13T12:05:04.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-13T16:46:00.000Z (about 3 years ago)
- Last Synced: 2024-11-28T21:36:24.516Z (2 months ago)
- Topics: extract, image, list, ocr, revolut, screenshot, stocks, tesseract
- Language: Go
- Size: 1.95 MB
- Stars: 74
- Watchers: 17
- Forks: 22
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Revolut Stocks List   [](https://goreportcard.com/report/github.com/nmapx/revolut-stocks-list) [](https://travis-ci.com/nmapx/revolut-stocks-list)
Extract Revolut stocks list from the list screenshot(s) ([example screenshot](./example-input.jpg) - use your mobile app for this).
I made this app since there is no official list of all available Revolut stocks.
**[Here](./LIST.md) you can find already extracted list of all available stocks. I will update it from time to time.**
## Technologies
- Go
- Docker with **compose**
- Tesseract OCR
- Make
## Requirements
- Docker >= 19.03 with **compose** >= 1.25
- Make >= 4.1 *(optional)*
> Note: use appropriate commands (found in Makefiles) without Make
## Setup guide
1. Clone the repository and navigate to the project root
2. Copy `.env.dist` file to `.env` and fill missing parameters
> Note: HOST_UID is your system user ID
3. Build docker image `make build`
4. Start container `make up` (development purposes only)
5. Run the script by executing appropriate command inside the container (see below)
6. Compile the app by executing `make -f Makefile.native build` inside the container
## Basic usage
### Docker
```bash
docker exec {CONTAINER_NAME} go run . extract
```
or
```bash
docker-compose -p {PROJECT_NAME} exec app go run . extract
```
### Binary
Binary not supported yet - use Docker environment.
### I'm just looking for the list
Scroll down. The list is as the bottom of this page.
## Advanced usage
### Input files (images/screenshots)
First of all - check [example screenshot](./example-input.jpg). Your screenshot(s) must follow the pattern!
The screenshot should be at least **720px wide** in order to preserve OCR accuracy (>99,9%)!
**OCR is still not the most accurate solution (about 2-3% misidentified tickers for screenshots smaller than 720px wide). In order to improve it take smaller screenshots (which means better quality per screenshot). For images which are at least 720px wide the accuracy is ~99,9%.**
You can specify multiple input files by adding more parameters. By default it's processing 1 file (filepath `./input.jpg`) which can be very long (complete stock list in 1 screenshot (possible on some mobiles)). See example below.
```bash
... extract --input ./this/is/input/file_1.jpg --input ./this/is/input/file_2.jpg --input ./this/is/input/file_3.jpg
```
### Output file (CSV)
Script generates 1 output file (including all input files in it). By default it's `./output.csv` - you can change the filepath. See example below.
```bash
... extract --output ./this/is/output/file.csv
```
### Languages
By default only English is being installed and used by the Tesseract library. In order to use also other languages like Polish or Russian you can add an optional parameters. You need to install appropriate language library (Tesseract) first (eg. [tesseract-ocr-data-pol](https://pkgs.alpinelinux.org/package/edge/community/x86_64/tesseract-ocr-data-pol)). See example below.
```bash
... extract --lang eng --lang pol --lang rus
```
### Whitelist
By default whitelist includes only A-Z characters (upper-case) for tickers and whole alphabet for companies names. It's the best setup but you can change it if you want to experiment a bit. See example below.
```bash
... extract --whitelist-tickers abcDEF123 --whitelist-names qwertyQWERTY
```
## License
[MIT License](./LICENSE)
## The list
As the result you will get a file with all recognized tickers and companies names.
[Here](./LIST.md) you can find already extracted list of all available stocks. I will update it from time to time.