lambtron / emojipacks Goto Github PK

View Code? Open in Web Editor NEW

1.3K 26.0 200.0 4.47 MB

CLI to bulk upload emojis to your Slack

Home Page: https://emojipacks.com

License: MIT License

Makefile 0.93% JavaScript 24.57% HTML 51.40% Python 22.69% Shell 0.41%

slack emoji emojis

emojipacks's Introduction

emojipacks

CLI to bulk upload emojis to your Slack!

Install

Note you must have node and npm installed. If you don't, go to nodejs.org and follow the install instructions there.

$ npm install -g emojipacks

$ git clone [email protected]:lambtron/emojipacks.git
$ cd emojipacks
$ make

Usage

There is only one command:

$ emojipacks

It'll ask you a few questions:

Slack subdomain: 20percentclub
Email address login: [email protected]
Password: *********
2FA Code: 123456  #  if 2FA is enabled
Path or URL of Emoji yaml file: ./packs/futurama.yaml

Then, let it work its magic:

Starting import
Got tokens
Logged in
Upload crumb is s-1437797544-90b75206a7-☃
Getting emoji page
Uploading bender with http://i.imgur.com/7zYM751.png
Uploading amywong with http://i.imgur.com/DgKkcCi.png
 .
 .
 .
Uploading hypnotoad with http://i.imgur.com/o7tyjxN.gif
Uploaded emojis

Note that the emoji pack to upload can be a path to a yaml file on your machine or a URL, like http://www.emojipacks.com/packs/food.yaml.

Optionally Pass Command Line Parameters

This will allow for easier batch uploading of multiple yaml files

$ emojipacks -s <subdomain> -e <email> -p <password> -y <yaml_file>

Run Batch Upload script

A file named batchUploadExample.sh is provided for your reference. Edit this file change the subdomain, email, and password parameters to your own and save it as batchUpload.sh or something similar.

This script will aid in the process of batch uploading.

It optionally takes an argument for the directory path that contains your yaml files. If this is not provided './packs' will be used by default.

$ ./batchUpload.sh [path_to_yaml_files]

Emoji Yaml File

Also note that the yaml file must be indented properly and formatted as such:

title: food
emojis:
  - name: apple
    src: http://i.imgur.com/Rw0Vlda.png
  - name: applepie
    src: http://i.imgur.com/g4RU1fM.png

..with the src pointing to an image file. According to Slack:

Square images work best
Image can't be larger than 128px in width or height
Image must be smaller than 64K in file size

Emoji Aliases

It is possible to give multiple names to a single emoji using yaml such as:

title: octicons
emojis:
  - name: pr
    aliases:
      - pullrequest
      - mergerequest
    src: https://i.imgur.com/rhwNxfc.png

Emoji packs

animals
clippy
fika
frontend
harrypotter
mario
occupy
officespace
omnom
futurama
food
skype
starwars
startups
businessfish
hipchat
twitch
parrotparty (Parrot Paint)
Finland
pokemongo: items
Pokémon Go: Pokémon (Prefixed pokemon-*)
politipack
nekoatsume
octicons
pokemon
devicon (Devicon)
hamsterdance (snipe/emojipacks)
avengers
Shiba Stickers (from Messenger)
gamedevmoji
AWS simple icons

Emoji packs from slackmojis.com

Want to contribute? Suggest an emoji pack!

Troubleshooting

This script will essentially log into your Slack and then submit a POST request on the emoji upload form page. If you are seeing errors, make sure that:

you have Slack privileges to add custom emojis: otherwise, the script won't be able to get to the emoji upload form
your credentials are correct: if you have done all of the following correctly try running the command emojipacks -d

Still having issues? Create an issue here.

Enjoyed this project? Check out my blog for more.

License (MIT)

WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|

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.

emojipacks's People

Contributors

Stargazers

Watchers

Forkers

brianjking wcjohnson11 teleject austinemayer yaleunix bdukes heitortsergent jodiwarren langerhans developmentnerd tanookiben fcokta hugovk omgmog villeristi jpiasetz crouchygt elldritch josegonzalez keithamus victormier obscurerichard lordlioath samusgray jdivock hansent ericfrancis mihar jordan8037310 memory5776 codecorrupt bpartridge83 nextalias rvillage gee-gee elischutze jparmenter malucky samrenick tonyisworking oneokorganization jaylynch kaiware007 templarian kozyty dleesalestreamsoft lukekuenneke akiokanno mistymagich wigsofoz intellifylearning anton-fedorov jordanbuchman ignoredambience kvalade pvasilion allonsyalexa dossy mollyhenderson izumin5210 takose dalepalmer txst-ctf bernardoat cosmicist douglance narze neldridge andrefs woganmay wuz zachfeldman kimkijoong tangphillip andrewpong dosull chrisdbrown aendra-rininsland worldspawn peteratticusberg isaacs samuelfullerthomas donaldrowens parthkolekar barnetchopper jkillian melinerunen bchalls jeje-50 heggy231 david-pettifor-nd snipe cometkim dustinleer bmacauley kenkatschke bit13labs qingy dillera mizuku

emojipacks's Issues

Steam Emoticons

I created packs of the emoticons of each game on Steam. The urls in the readme should be usable with emojipacks.

image upload from github seems to have not worked...

emojipacks logs me in and seems to process my yml, but emoji do not show up on the slack team. i can manually add emoji via the web U/I so it doesn't seem to be a permissions thing. sample from the yaml:

title: ingress
emojis:
- name: ada
src: https://github.com/thekewe/ingress-slack-emoji/blob/master/emoji/ada_emoji.png
- name: axa
src: https://github.com/thekewe/ingress-slack-emoji/blob/master/emoji/axa_emoji.png
- name: capsule

(etc.. )

output:

Path or URL of Emoji yaml file: ./ingress.yml
Starting import
Got tokens
Logged in
Upload crumb is [redacted]
Getting emoji page
Uploading ada with https://github.com/thekewe/ingress-slack-emoji/blob/master/emoji/ada_emoji.png
Uploading axa with https://github.com/thekewe/ingress-slack-emoji/blob/master/emoji/axa_emoji.png

"/usr/bin/env node --harmony: no such file or directory"

The env command on some *nix systems or git bash on Windows can only accept one argument, so you will receive this error if you try and run emojipacks: "/usr/bin/env node --harmony: no such file or directory"

A potential fix is to remove the --harmony option. This does not seem to cause any issues when running with the latest stable build of node.

uninstall option?

It would be nice to delete every one in a pack as well, rather than manually having to "x" them out on the Slack admin page.

--harmony doesn't work in Ubuntu

Seems that flag doesn't play well with some distros, but works on Mac. See here: hiddentao/melkor#12

I removed "--harmony" and worked for me in Ubuntu 14.04.3.

Handle 2FA cycle

Emojipacks doesn't work on accounts that are 2FA enabled

emojipacks
Slack subdomain: redacted
Email address login: [REDACTED]
Password: **************
Path or URL of Emoji yaml file: http://www.emojipacks.com/packs/businessfish.yaml
Starting import
Got tokens
Logged in
Upload crumb is undefined
Uh oh! Error: Login error: could not get emoji upload crumb for https://redacted.slack.com

Disabling 2FA works, but I'm sure there's a way to handle the full circle.

$ emojipacks
Slack subdomain: redacted
Email address login: [REDACTED]
Password: **************
Path or URL of Emoji yaml file: http://www.emojipacks.com/packs/businessfish.yaml
Starting import
Got tokens
Logged in
Upload crumb is s-1442851577-a17fca3392-☃
Getting emoji page
Uploading bfexcite with http://i.imgur.com/cUqre6P.png
Uploading bfkiss with http://i.imgur.com/NryT58n.png
Uploading bfquestion with http://i.imgur.com/8RwFbed.png
Uploading bfdetermine with http://i.imgur.com/rlJ2w4w.png

Add 'related projects' in readme

Here is one that is cool: https://github.com/samuelfullerthomas/emojiripper

If there are more we should have a related emoji/slack projects.

Running "emojipacks" results in: /usr/bin/env: ‘node --harmony’: No such file or directory

To give a bit more detail, here is the system I'm currently running:

OS: Korora 25
Kernel: 4.8.15-300.fc25.x86_64
Node version: v6.9.1
NPM version: 3.10.8

After finding https://bbs.archlinux.org/viewtopic.php?id=168479, it seems that to resolve the error, changing the shebang to #!/usr/bin/node will allow the program to run without presenting the error.

test directory can't be created

emojipacks -d kept failing until I manually ran mkdir /usr/local/lib/node_modules/emojipacks/test.

I was getting this error:

Uh oh! Error: ENOENT: no such file or directory, open '/usr/local/lib/node_modules/emojipacks/test/Slack.html'

Add prefixes for slackmoji packs

Some ideas to prevent name conflicts between different packs:

prefix slackmojis-scrabble-letters.yaml with scrabble-
prefix slackmojis-facebook-reaction.yaml with fb-

From #123 (comment)

Missing File Error

With Node 4.0.0 on OSX 10.10, seeing this error with emojipacks -d

Uh oh! Error: ENOENT: no such file or directory, open '/usr/local/lib/node_modules/emojipacks/test/Slack.html'

I noticed there was a problem when the script would stall at the first emoji upload... and never move on.

Problems in skype.yaml

cc @lambtron

Upload crumb is undefined

I'm able to log in, but the upload crumb is undefined and fails. Has the Slack website changed somehow breaking the system?

twitch pack doesn't seem to work

It goes through the motions but nothing is actually uploaded.

error: unknown option `-s'

Hi there!

I'm running into an issue when I try to run this script via batch or in the one-line version (not interactive mode).

 snipe@deepthought ~/Sites/emojipacks$ sh ./batchUpload.sh
./packs/animals.yaml

  error: unknown option `-s'

./packs/businessfish.yaml

  error: unknown option `-s'

./packs/clippy.yaml

  error: unknown option `-s'
... etc...

This seems to happen regardless of whether I pass the optional path:

snipe@deepthought ~/Sites/emojipacks$ sh ./batchUpload.sh packs
./packs/animals.yaml

  error: unknown option `-s'

./packs/businessfish.yaml

  error: unknown option `-s'

./packs/clippy.yaml

  error: unknown option `-s'

And also in the one-liner.

snipe@deepthought ~/Sites/emojipacks$ emojipacks -s MYSLACKNAME -e MYSLACKEMAIL -p MYSLACKPASSWORD -y ./packs/animals.yaml

  error: unknown option `-s'

Installed via npm.

I'm probably missing something really obvious. ☹️ Any ideas?

Thanks!

Allow upload of local files.

Is this possible? Didn't see anything in the readme about it.

Add Hipchat emoji pack

Went ahead and wrote a little YAML file for Hipchat emojis based on this page: https://www.hipchat.com/emoticons

hipchat.yaml

Missing command parameteres

It will be nice to add command parameters in order to add it to a silent script upload. Ie:

emojipacks -d <slackdomain> -u <username> -p <password> <file.yaml>
or emojipacks <file.yaml>

Request: SAML / SSO support

So organizations that use SAML for SSO support do not currently work, because the login form is not used in the fashion this script desires. Don't know if this is something that could even adequately be supported, but would be neat if it could.

Problem in octicons.yaml

Found 1 error in packs/octicons.yaml
Error: image can't be larger than 128px in width or height: (129, 114) https://i.imgur.com/jv3mw7d.png

cc @keithamus

Problems in skypeflags.yaml

cc @lambtron

Problems in hipchat.yaml

Found 9 errors in packs/hipchat.yaml

cc @lambtron

SyntaxError: Unexpected token *

I've installed via both npm and git clone, but result in an error when I try to run emojipacks

> emojipacks

/Users/USERNAME/Work/Development/emojipacks/bin/emojipacks:22
co(function *() {
            ^
SyntaxError: Unexpected token *
    at Module._compile (module.js:439:25)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:497:10)
    at startup (node.js:119:16)
    at node.js:906:3

hipchat > firstworldproblems access denied causing failure

The firstworldproblems emoji is returning access denied. This causes hipchat imports to freeze.

Allow upload of files on my local machine instead of requiring they be hosted somewhere

Does not work for Google Auth teams

The app fails when trying to import packs into a Slack team that uses Google accounts for authentication.

(...)
Starting import
Uh oh! Error: Login error: could not get login form for https://myteam.slack.com

Improve the error messages

Somewhat minor, but when uploads aren't working, the terminal just hangs after entering the YAML file location. So far, I've always been able to solve it, but it's somewhat like searching for a needle in a haystack - so far, I've run into issues with:

my YAML file format
duplicate names between emojis in the YAML file and in my Slack account
missing names for emojis in the YAML file
incorrect file URLs for the emoji images
had an upload hang after beginning to upload the first image (the hanging was a result of duplicate names), which I then killed and fixed the issue, but when I checked Slack, the emoji that began to upload had not been uploaded, yet I couldn't get the fixed YAML file to upload until I removed the image that began to upload in the last attempt

It's been suggested that I run emojipacks with the -d flag, yet when I've tried this, nothing is output, as the command simply hangs and I have to kill it. It would be great if errors like this caused the command to fail with a message rather than simply hanging and relying on us to figure it out.

I'm not a formally trained programmer, but this might be an interesting problem for me, I've never written a CLI program though - if you know of any good resources for learning to write them, I'd potentially be interested in writing a fix for you - big fan of the tool!

UnhandledPromiseRejectionWarning

This is on Windows, tried in two different shells (cmd & mingw64). Also tried both with supplying all the options via command-line, and with interactive responses. Any ideas?

Slack subdomain: xxxxxxxxxxx
Email address login: xxxxxxxxxxx
Password: ****************
Path or URL of Emoji yaml file: ./pokemon_emojipack.yml
Starting import
Got tokens
Logged in
Getting emoji page
Uploading undefined with undefined
(node:14684) UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 3): TypeError: Cannot read property 'name' of undefined
(node:14684) DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

After this the execution appears to hang.

Problems in slackmojis.yaml

cc @dleesalestreamsoft @lambtron

Support for teams with SSO enabled?

Our slack team authenticates against GSuite - is this type of authentication supported by emojipacks? Here's the error I get when running in debug mode:

Slack subdomain: subdomain
Email address login: [email protected]
Password: ***************
Path or URL of Emoji yaml file: https://raw.githubusercontent.com/Surgo/aws_emojipacks/master/noprefix-emojipacks.yml
Starting import
Got tokens
Logged in
Uh oh! Error: Login error: could not get emoji upload crumb for https://subdomain.slack.com```

Adding Slackemojis pack.

Converted the slackmojis.com list into a pack, has a bunch all in one.
slackemojis.txt

Need high res images for retina, look like poo poo in retina

Create a new release for NPM?

Thanks so much for the tool! I installed the version from NPM, but it failed to login. Looks like I needed the no_sso from #14, but I don't think that version has made it to NPM yet. I cloned the repo, and was able to use the updated codebase to upload a pack.

Would you be able to push a new version? I'd like to reference this tool in a blog post I'm writing soon about installing emoji packs into slack.

Thanks!

🍻

Any relation to emojipacks.com?

Are you the one behind: emojipacks.com?

Requesting a username and password is super not cool, and seems super vuln to me.

This should use oAuth or an API token or something.

UnhandledPromiseRejectionWarning error

Hi there,

I'm getting the below issue when trying to use https://slackmojis.com/emojis.yaml.

I turned off 2FA in case it was causing issues and the same problem happened. The number (in the below case "5778") next to 'node' appears to change each time I run it. I don't know if this is relevant or not.

I have tried on two different Macs and also a Fedora VM, all using node v7.10.0. I used the npm install method and also on one of the Macs built from the checked out repo. Same issue across the board.

Any ideas on how to get past this?

Password: ***********************
Starting import
Got tokens
2FA Code: ******
Logged in
Getting emoji page
(node:5778) UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 1): TypeError: Cannot convert undefined or null to object
(node:5778) DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

UnhandledPromiseRejectionWaringin error

After the unhandled exepcion the app doesn't properly exit to the terminal:

add mattermost support

add support of mattermost (open source clone of slack)

Allow importing of aliases from emojipacks

Reticketed as another possible feature stemming from #116

Would be rad if we could import aliases (even as their own first-class citizen in the yaml, as it's own object not tied to an emoji being imported)

More emojis

Just wanted to let you all know I made some yml files and published on github over here https://github.com/spoike/emojis

The emojis have been uploaded on imgur and the yml files are referencing them. It is possible to use the raw urls specified in the README file in the emojipacks program.

Write a script to update slackmojis.com emojis

https://slackmojis.com gets updated with new emojis every so often. We should keep up to date with it! But there are so many, and life is so hard! Good thing they have https://slackmojis.com/emojis.json for developers to work with. A script should be written to parse it and automatically put it in an emojipack format.

occupy hand signals

This could be handy for someone: https://gist.github.com/isaacs/24314ec7e682f13cabbef2f5aa8ee875

Context: https://en.wikipedia.org/wiki/Occupy_movement_hand_signals

Issue using the pack

When going through the initial process I get to enter my company name and email, but after entering the email it does not proceed to the password step as if pending for some more information. Also tried enclosing the email in '' and "" but doesn't seem to work. Also tried your demo domain and email adress to see if it was something in the logging step. Using bash for windows to run the commands

Cannot delete characters in pasword input

When i try to delete part of the password i entered, it keeps adding characters instead of delete them.

Add front end emojis

https://github.com/FrontEndHappyHour/frontend-slack-emojis

image-checker.py fails under Python 3

Stack trace:

Checking ../packs/scrabble.yaml.Traceback (most recent call last):
  File "image-checker.py", line 182, in <module>
    errors, warnings = check_yaml(filename, args.resize)
  File "image-checker.py", line 106, in check_yaml
    download = wget.download(url, tempfile.gettempdir(), bar=None)
  File "/home/thomas/ingress/emojipacks/test/venv/lib/python3.6/site-packages/wget.py", line 526, in download
    (tmpfile, headers) = ulib.urlretrieve(binurl, tmpfile, callback)
  File "/usr/lib64/python3.6/urllib/request.py", line 248, in urlretrieve
    with contextlib.closing(urlopen(url, data)) as fp:
  File "/usr/lib64/python3.6/urllib/request.py", line 223, in urlopen
    return opener.open(url, data, timeout)
  File "/usr/lib64/python3.6/urllib/request.py", line 532, in open
    response = meth(req, response)
  File "/usr/lib64/python3.6/urllib/request.py", line 642, in http_response
    'http', request, response, code, msg, hdrs)
  File "/usr/lib64/python3.6/urllib/request.py", line 570, in error
    return self._call_chain(*args)
  File "/usr/lib64/python3.6/urllib/request.py", line 504, in _call_chain
    result = func(*args)
  File "/usr/lib64/python3.6/urllib/request.py", line 650, in http_error_default
    raise HTTPError(req.full_url, code, msg, hdrs, fp)
urllib.error.HTTPError: HTTP Error 403: Forbidden

It looks like the monkey patch line to set the UserAgent for the wget library isn't taking effect for Python 3, this is probably because that library uses different urllib implementations on different Python versions.

Ran into this whilst trying to update the test suite for #52.

"Foodz" YAML file is missing?

http://www.emojipacks.com/packs/foodz.yaml gives me "Not Found" message.

CLI does not allow easily path interpretation

After installing the package globally, it is not easy to get the paths of the files (it's undocumented in the Readme). To the average user it is probably non-trivial to how to do get the full path to the yaml files installed in the directory where emojipacks is.

We should probably check file path passed to see if it's in packs folder.

For example:

Path or URL of Emoji yaml file: animals.yaml
Does the path to the yaml file look right? :)

It should allow animals.yaml, and just animals itself.

Thanks!

lambtron / emojipacks Goto Github PK

emojipacks's Introduction

emojipacks

Install

Usage

Optionally Pass Command Line Parameters

Run Batch Upload script

Emoji Yaml File

Emoji Aliases

Emoji packs

Emoji packs from slackmojis.com

Troubleshooting

License (MIT)

emojipacks's People

Contributors

Stargazers

Watchers

Forkers

emojipacks's Issues

Recommend Projects

Recommend Topics

Recommend Org