Skip to content

Commit

Permalink
Removed unused icons and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ilcardella committed Jan 13, 2020
1 parent 29fda0b commit 1e6d136
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 33 deletions.
38 changes: 15 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ your assets and the overall profit (or loss!)
## Dependencies

- Python 3.6+
- Pipenv (for development)
- Pipenv (only for development)
- PyGObject: https://pygobject.readthedocs.io/en/latest/index.html
- AlphaVantage: https://www.alphavantage.co/

Expand All @@ -35,28 +35,27 @@ TradingMate uses AlphaVantage to fetch markets data online:

- Visit AlphaVantage website: `https://www.alphavantage.co`
- Request a free api key
- Insert these info in a file called `.credentials` in `$HOME/.TradingMate/data`
- Insert these info in a file called `.credentials` in `/opt/TradingMate/data`
```
touch $HOME/.TradingMate/data/.credentials
touch /opt/TradingMate/data/.credentials
```

This must be in json format and contain:
```
{
"av_api_key": "apiKey"
"av_api_key": "key_from_alphavantage"
}
```

- Revoke permissions to read the file by others

```
cd $HOME/.TradingMate/data
sudo chmod 600 .credentials
sudo chmod 600 /opt/TradingMate/data/.credentials
```

### Configuration file

The `config.json` file is in the `$HOME/.TradingMate/config` folder and it contains several parameters to personalise how TradingMate works.
The `config.json` file is in the `/opt/TradingMate/config` folder and it contains several parameters to personalise how TradingMate works.
These are the descriptions of each parameter:

- **trading_logs**: The absolute path of the trading logs to automatically load on startup
Expand All @@ -66,20 +65,18 @@ These are the descriptions of each parameter:

## Start TradingMate

You can start TradingMate in your current terminal
You can start TradingMate with
```
trading_mate
sudo trading_mate
```
or you can start it in detached mode, letting it run in the background

Otherwise you can change ownership of the `/opt/TradingMate` folder:
```
nohup trading_mate >/dev/null 2>&1 &
sudo chown -R $USER: /opt/TradingMate
```

## Stop TradingMate

To stop a TradingMate instance running in the background
and then run `TradingMate` without sudo
```
ps -ef | grep trading_mate | xargs kill -9
trading_mate
```

## Uninstall
Expand Down Expand Up @@ -111,14 +108,12 @@ pipenv run pytest

### Documentation

The Sphinx documentation contains further details about each TradingMate module
with source code documentation of each component.

The Sphinx documentation contains further details about each TradingMate module.
Read the documentation at:

https://tradingmate.readthedocs.io

You can build it locally from the "workspace" root folder:
You can build it locally from the repo root folder:
```
pipenv run sphinx-build -nWT -b html doc doc/_build/html
```
Expand All @@ -141,6 +136,3 @@ If you instead find problems or you have ideas and suggestions for future
improvements, please open an Issue. Thanks for the support!

Python GTK+ 3 reference: [here](https://lazka.github.io/pgi-docs/index.html#Gtk-3.0)

## Credits
Icons by <a target="_blank" href="https://icons8.com">Icons8</a>
11 changes: 1 addition & 10 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,14 @@
data_files=[
(os.path.join(os.sep, "opt", "TradingMate", "config"), ["config/config.json"]),
(os.path.join(os.sep, "opt", "TradingMate", "data"), ["data/trading_log.json"]),
(
os.path.join(os.sep, "opt", "TradingMate", "data", "assets"),
[
"src/UI/assets/trading_mate_icon.png",
"src/UI/assets/add_icon.png",
"src/UI/assets/open_file_icon.png",
"src/UI/assets/save_file_icon.png",
"src/UI/assets/save_as_file_icon.png",
],
),
(
os.path.join(os.sep, "opt", "TradingMate", "data", "assets", "gtk"),
[
"src/UI/assets/gtk/add_trade_window_layout.glade",
"src/UI/assets/gtk/main_window_layout.glade",
"src/UI/assets/gtk/notebook_page_layout.glade",
"src/UI/assets/gtk/settings_window_layout.glade",
"src/UI/assets/gtk/log_window_layout.glade",
],
),
],
Expand Down
Binary file removed src/UI/assets/add_icon.png
Binary file not shown.
Binary file removed src/UI/assets/open_file_icon.png
Binary file not shown.
Binary file removed src/UI/assets/save_as_file_icon.png
Binary file not shown.
Binary file removed src/UI/assets/save_file_icon.png
Binary file not shown.
Binary file removed src/UI/assets/trading_mate_icon.png
Binary file not shown.

0 comments on commit 1e6d136

Please sign in to comment.