Skip to content
upload image to github and return corresponding url.
Branch: master
Clone or download
Pull request Compare This branch is 10 commits behind huntzhan:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
img2url
scripts
tests
.gitignore
.travis.yml
MANIFEST.in
README.md
conftest.py
pytest.ini
requirements.txt
setup.cfg
setup.py
test_requirements.txt

README.md

img2url

Introduction

img2url transfers a local image file to an url by uploading the file to GitHub. img2url helps you write portable document, especially markdown file, in such a case you don't need to worry about where to place the static resource like images!

Install

img2url is a Python project, use pip to install:

pip install img2url

Command-Line Interface

And the CLI is pretty simple:

$ img2url --help 
Usage:
    img2url <path>
    img2url (-m | --markdown) <path>

Options:
    -m, --markdown

Example:

$ ls -al
total 56
drwxr-xr-x  4 haoxun  staff    136 Aug 13 21:26 .
drwxr-xr-x  8 haoxun  staff    272 Aug 13 21:23 ..
-rw-r--r--@ 1 haoxun  staff  23975 Aug 13 21:26 image1.png
-rw-r--r--@ 1 haoxun  staff   3727 Aug 13 21:26 image2.png

$ img2url image1.png 
https://cdn.rawgit.com/huntzhan/img2url-repo/master/image1.png

$ img2url --markdown image2.png 
![image2.png](https://cdn.rawgit.com/huntzhan/img2url-repo/master/image2.png)

Configuration

User should configure img2url before actually using it, so that img2url knows where to upload the files. Currently, img2url only supports uploading to GitHub public repository.

Path of configuration file:

  • ~/.img2url.yml, by default.
  • IMG2URL_CONFIG_PATH, customized path.

Example of .img2url.yml:

token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
user: img2url-testing
repo: img2url-testing-travisci
proxies:
  https: socks5://127.0.0.1:1080

Required fields:

  • token: Personal access tokens of your GitHub account. If you don't have one, click "Generate new token" and select the "repo" scope, then record the generated token.
  • user: Account of GitHub.
  • repo: The repository to store images.

Optional fields:

  • branch: If not defined, use master as the default branch.
  • path: Path to store the uploaded files in your repository. If not defined, use the root of repository by default.
  • proxies: If defined, use proxy to make API requests instead of connecting directly.
  • message_template_create: Message template for creating new file, supported variables: {filename}, sha, time.
  • message_template_update: Message template for updating existed file, supported variables: {filename}, sha, time.
  • commiter_name: Username for commit message.
  • commiter_email: Email for commit message.
You can’t perform that action at this time.