Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
bskim45 committed Jan 15, 2022
0 parents commit ad7c3e2
Show file tree
Hide file tree
Showing 24 changed files with 2,961 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
root = true

[*]
charset=utf-8
end_of_line=lf
indent_size=4
indent_style=space
insert_final_newline=true
trim_trailing_whitespaces=true
max_line_length = 80

[*.py]
indent_size=4
quote_type=single

[*.json]
indent_size=2

[*.sh]
indent_size=2

[*.md]
indent_size=2

[{Makefile,**.mk}]
indent_style = tab
62 changes: 62 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/

# pyenv
.python-version

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# ide
.vscode
.idea

# user
includes.list
link.sh
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "alfred-workflow"]
path = alfred-workflow
url = https://github.com/deanishe/alfred-workflow.git
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Bumsoo Kim

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.
32 changes: 32 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
NAME := alfred-coin-ticker
WORKFLOW_FILENAME := $(NAME).alfredworkflow
VERSION_FILE := version
TARGET_FILES := $(shell cat includes.list)

default: build

.PHONY: build
build: $(WORKFLOW_FILENAME)

$(WORKFLOW_FILENAME): $(TARGET_FILES)
@echo "> Packaging..."
./build.sh

.PHONY: test
test:
python -m unittest discover -s tests -v

.PHONY: clean
clean:
rm -f $(WORKFLOW_FILENAME)

.PHONY: bump_version
bump_version:
@if [ -z $(version) ]; then \
echo Usage: make bump_version version=1.0.0; \
exit 1; \
fi;
@echo Current version: $(shell cat $(VERSION_FILE))
@(read -e -p "Bump to version $(version)? [y/N]: " ans && case "$$ans" in [yY]) true;; *) false;; esac)
@echo $(version) > version
@sed -i.bak 's#<string>[0-9]*.[0-9]*.[0-9]*</string>#<string>$(version)</string>#' info.plist
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# alfred-coin-ticker

An [Alfred Workflow](http://www.alfredapp.com/) that provides current price
and status about cryptocurrency from [cryptocompare.com].

Supports Alfred 3 and Alfred 4 on macOS 10.7+ (Python 2.7).

## Install

[Download the latest package][latest release]

## Usage

Simply type `coin` to get the current price of favorite coins.

`coin list` shows the current price of the top 10 coins by market cap.

`coin [TICKER]` shows the current price of the coin with that ticker.

`coin add [TICKER] [POSITION(optional)]` adds new coin to the favorites.
Position starts from 1.

`coin remove [TICKER]` removes a coin from the favorites.

`coin set currency [CURRENCY]` sets the fiat currency (3 letters).

`coin reset` resets all settings to default and deletes all caches/saved data.
Please use with caution.

`coin help` shows all available commands.

## Artworks

- All cryptocurrency icons are from [cryptocompare.com]
- App icon https://www.iconfinder.com/icons/2907507/bitcoin_btc_coin_cryptocurrency_icon

## License

The code is released under the MIT license. See [LICENSE](LICENSE) for details.

Awesome [alfred-workflow](https://github.com/deanishe/alfred-workflow) library
by [@deanishe](https://github.com/deanishe) is also released under
[MIT License](alfred-workflow/LICENCE.txt).

[cryptocompare.com]: https://www.cryptocompare.com/
[latest release]: https://github.com/bskim45/alfred-coin-ticker/releases/latest/download/alfred-coin-ticker.alfredworkflow
1 change: 1 addition & 0 deletions alfred-workflow
Submodule alfred-workflow added at 70d04d
Loading

0 comments on commit ad7c3e2

Please sign in to comment.