Skip to content

Latest commit

 

History

History
36 lines (20 loc) · 1.07 KB

README.md

File metadata and controls

36 lines (20 loc) · 1.07 KB

paper-gamification

A tool to help you write a paper.

Paper-gamification is a python script that watches a paper written in text format and calculates text statistics as soon as you hit save.

Dependencies

  1. Requests - http://docs.python-requests.org/en/latest/

pip install requests

  1. Watchdog - http://pythonhosted.org/watchdog/

pip install watchdog

  1. Docx Parser - https://github.com/mikemaccana/python-docx

Please install Docx Parser according to their setup instructions

Usage

python tracker.py <paper-file> <publish-host> <paper-id>

  • <paper-file> - Source of your paper
  • <publish-host> - Root url of your deployed paper-gamification-website (Avoid a trailing '/')
  • <paper-id> - The database id of your paper in the paper-gamification-website (hacky :D)

Example

python tracker.py /usr/path/to/my-paper.md http://localhost:3000 5

Contribution

Please feel free to contribute! I'm rather new to open source publishing ;)