Commit Graph

142 Commits

Author SHA1 Message Date
Artem Veremey
0e5a392427 Adding a new Docker configuration (#634)
* Adding a new docker configuration

* Updating file permissions

* Renaming to gst

* Updating the note to customize environment variables

* Updating dockerignore and docker-compose

* Typo in gst-poetry-deps
2021-08-02 13:41:24 -07:00
Timothy Langer
06957c27f3 Add Sentiment Investor API integration (#562)
* Add SentimentInvestor core and social metrics

* Added `metrics` and `social` commands to behaviour analysis menu
* `metrics` fetches the core metrics for a given ticker from
  SentimentInvestor: AHI, RHI, SGP and sentiment score.
* `social` fetches the aggregated data from several social media
  networks, i.e. the number of mentions and the sentiment score
  associated with a specific ticker on each network

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Format code to conform to PEP8 style guide

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Use `argparse` to handle command-line arguments

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Use `multiprocessing` to reduce wait time

* Reduce `metrics` from 7.2s to 2.9s
* Reduce `social` from 13.5s to 5.6s
* NB: These times could be reduced further but that would require
  changes to `sentipy` itself

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Add `historical` command to plot past week of data

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Add three new commands to discovery mode

* `popular` for stocks with the highest AHI
* `emerging` for stocks with the highest RHI
* `positive` for stocks with the highest sentiment scores

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Aggregate data for past week when showing table

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Fix `-t` flag not working for `social` command

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Handle lacking or incomplete historical data

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Improve error handling for unsupported stocks

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Remove `positive` command

* Sorting SentimentInvestor data by sentiment does not provide much
  value, seeing as it simply returns stocks that have very few comments,
  giving it a sentiment score of 1.0, which is inaccurate and misleading

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Reformat code per project guidelines

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Remove `positive` from list of valid commands

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* `poetry add sentiment-investor`

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Add SentimentInvestor to "About us" section

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Use `typing.List` annotation instead of `builtins.list`

* This is to support Python versions older than 3.9

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Add `sentiment-investor` to `requirements-full.txt`

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Add SentimentInvestor API key check

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Show correct program name in help message

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Add README documentation for newly added commands

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Make changes as requested by code review

* Coloring applied to the whole row in `metrics` and `social` commands
* Convert `--ticker` flag into an optional positional argument for
  single-argument commands such as `metrics` and `social`
* Make help menus and command descriptions far more detailed
* Explain what AHI, RHI, SGP and sentiment score are and how they are
  calculated by Sentiment.
* `historical` command is now sorted with the most recent date first
* `historical` command output table can be sorted using new `--sort` and
  `--direction` arguments
* Non-fatal warning and error messages have been suppressed

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Wrap command methods in try-except

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Add SentimentInvestor API key help

* Add to the top-level README
* Adjust environment variable name to conform with standard set by
  others, start it with GT_

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>

* Comment `coinpaprika` erroring line

* https://github.com/GamestonkTerminal/GamestonkTerminal/pull/562#issuecomment-887842888

Signed-off-by: Timothy Langer <zeevox.dev@gmail.com>
2021-07-28 23:00:20 +01:00
DidierRLopes
880e637c33 Improve main readme (#553) 2021-07-16 19:20:06 +01:00
octoshrimpy
df576a689a Adds readme link to conda installation directions; Adds drawio app map (#528)
* Install anaconda links

* AUR comment

* Added pages map from draw.io

* Update Untitled Diagram.drawio

* Update Untitled Diagram.drawio

* Update Untitled Diagram.drawio

* finished mapping

* borders and prettiness

* move drawio to proper place

* Update application mapping.drawio
2021-07-04 07:03:54 +01:00
DidierRLopes
e1612f905d Update donation section with patreon (#526)
* Update donation section with patreon

* Update based on pylint update it seems

* remove git import to fix bugs

* another pylint complain

* pylint stop crying pls
2021-06-30 00:22:03 +01:00
DidierRLopes
c6976647bf Update README.md 2021-06-28 01:28:04 +01:00
Artem Veremey
99c2a75e8b Recommend requirements.txt for Windows (#523) 2021-06-27 15:46:39 -07:00
DidierRLopes
1395dfe039 Bug fixes and code improvements (#519)
* Add README link to each menu

* Retrieve good error when #517 happens

* Fix column names with numbers in dataframes

* Update README.md

* ignore false positive
2021-06-27 10:26:11 +01:00
DidierRLopes
d7bb5a9456 Add Fear And Greed Index command to Economy menu (#509)
* Add CNN feargreed to economy menu

* Update README.md

* Update README.md

* Update ROADMAP.md

* Update README.md
2021-06-23 20:56:10 +01:00
DidierRLopes
6cf8b10379 Update README.md 2021-06-21 17:50:19 +01:00
DidierRLopes
3c438fd84b Improve-UX (#506)
* Add about us to main commands

* Add git hash to terminal welcome message to pin gst version down

* missed pylint

* Update poetry with gitpython

* Update ROADMAP.md

* Add partnerships to about us
2021-06-18 19:35:47 +01:00
Pritesh K
e592fbaa4f Fixing conda environment creating command (#488)
`conda create --file environment.yml -n gst` won't work. This command tries to parse every line in the `environment.yml` as a package name.

You should use` conda env create --file environment.yml -n gst`.
2021-06-07 09:30:05 -04:00
Artem Veremey
87ac6834e8 Update conda docs (#485)
* Updating conda configuration instructions

* Add a line break
2021-06-03 14:12:04 -07:00
DidierRLopes
a1d287278c Replace y2b tutorial link and fix screener float short option (#484)
* Fix screener comment option

* Fix link for install tutorial

* Update python descriptions
2021-06-03 20:13:24 +01:00
didier
711794d3dd Add running terminal on Apple M1 2021-05-29 19:35:54 +01:00
DidierRLopes
b6479f63da Update README.md 2021-05-27 19:33:38 +01:00
didier
d2cfbdb27d Fix FRED API KEY name #465 2021-05-26 23:54:29 +01:00
Artem Veremey
3f8bfae86a Updating README refs for bug labels 2021-05-23 16:45:59 -07:00
Chavithra PARANA
899360cf96 degiro integration : update doc 2021-05-22 16:43:23 +02:00
Chavithra PARANA
5337ee883d degiro integration : adding authors 2021-05-17 23:41:48 +02:00
Chavithra PARANA
506e1c4221 degiro integration : update doc 2021-05-17 23:12:42 +02:00
Chavithra PARANA
11fb1ac883 degiro integration : update main README 2021-05-16 20:28:25 +02:00
DidierRLopes
8746041a81 Update README.md 2021-05-07 23:50:50 +01:00
DidierRLopes
a6a7bcc259 Update README.md 2021-05-07 23:44:05 +01:00
DidierRLopes
76dd3d081e Update README.md 2021-05-07 23:36:13 +01:00
DidierRLopes
54f4039bfb add donation sector and replace install walkthough 2021-05-07 23:28:00 +01:00
jose-donato
eaf61e0392 Added twitter shield to README 2021-05-04 20:29:55 +01:00
Ivar Stangeby
376d7f39b2 Fixed README.md 2021-05-03 19:10:30 +02:00
Ivar Stangeby
70de28589a Added mypy 2021-05-03 18:44:08 +02:00
DidierRLopes
ba37422f26 Update README.md 2021-05-03 15:35:42 +01:00
Jamie
3494e232bc round 2 changes part 1 2021-05-03 07:55:00 -04:00
Jamie
40368333b9 remerge finnhub info 2021-05-02 19:49:11 -04:00
Jamie
ae64ad88fa change key names and readme format 2021-05-02 15:45:21 -04:00
Jamie
fec6f085aa merge main 2021-05-01 20:18:56 -04:00
DidierRLopes
2fbe477128 Update README.md 2021-05-01 22:12:30 +01:00
DidierRLopes
cf569a6c35 Update README.md 2021-05-01 16:50:42 +01:00
DidierRLopes
c46ba34369 Update latest logo 2021-05-01 16:49:59 +01:00
Jamie
5f9ef3ddee add order book command 2021-04-30 22:49:30 -04:00
DidierRLopes
b1037b391e Add installing/updating Microsoft C++ Build tools 2021-05-01 02:05:55 +01:00
DidierRLopes
cc84366ca3 Add disclaimer to README 2021-05-01 01:35:44 +01:00
Jamie
34af0b48dd add coinmarketcap to readme (addressing issue) 2021-04-30 12:23:25 -04:00
Jamie
465c88893c update discord 2021-04-26 16:09:42 -04:00
DidierRLopes
04f8b87548 Merge pull request #399 from piiq/feature/reddit-api-hint
Add a hint on adding the reddit api credentials
2021-04-25 21:40:46 +01:00
Theodore Aptekarev
3099a9eb5d Add a hint on adding the reddit api credentials 2021-04-25 23:19:29 +03:00
Rowan Harley
4cae3e59e7 Update README.md 2021-04-25 16:26:54 +01:00
Rowan Harley
62289f5fde Update README.md 2021-04-25 14:37:46 +01:00
Rowan Harley
f01035435a Update README.md
Changed readme to include optional process to speed up the terminal opening in the future, by using a simple batch file
2021-04-25 13:28:03 +01:00
DidierRLopes
d7287c2048 Update README.md 2021-04-25 11:25:21 +01:00
DidierRLopes
9299fb956e Update README.md 2021-04-25 10:59:51 +01:00
didier
970b31dea6 start adding troubleshoot file 2021-04-25 10:30:44 +01:00