{"id":17050584,"url":"https://github.com/griatch/wordtrack","last_synced_at":"2025-04-12T16:24:57.029Z","repository":{"id":23106132,"uuid":"26460407","full_name":"Griatch/wordtrack","owner":"Griatch","description":"Tracks your novel writing progress in a way inspired by nanowrimo.org.","archived":false,"fork":false,"pushed_at":"2019-10-13T02:06:08.000Z","size":504,"stargazers_count":5,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-26T10:48:12.410Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Griatch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-10T23:15:52.000Z","updated_at":"2023-10-17T23:20:43.000Z","dependencies_parsed_at":"2022-08-21T20:10:47.221Z","dependency_job_id":null,"html_url":"https://github.com/Griatch/wordtrack","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Griatch%2Fwordtrack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Griatch%2Fwordtrack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Griatch%2Fwordtrack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Griatch%2Fwordtrack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Griatch","download_url":"https://codeload.github.com/Griatch/wordtrack/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248594949,"owners_count":21130452,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-14T09:57:14.184Z","updated_at":"2025-04-12T16:24:56.999Z","avatar_url":"https://github.com/Griatch.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Wordtrack\n=========\n\nThis is a wordcount tracker that mimics the word-counting mechanism\nand statistics shown by [NaNoWriMo](www.nanowrimo.org) (National Novel\nWriting Month), a nonprofit-run event where you attempt to write a\nnovel of 50 000 words during the month of November.\n\nNo code of theirs were used and this little program is not in any way\nrelated or endorsed by the NaNoWriMo organization. I just thought\ntheir display was nice and encouraging and would like to have it for\nother times of the year too:\n\n![plot](plot_example.png)\n\n```\n Period: 2014-11-01 - 2014-11-30\n\n Your average per day:  1951\n Words written today:   1164\n Target word count:     50000\n Target average word\n        count per day:  1667\n Total words written:   25372\n Words remaining:       24628\n Current day:           13\n Days remaining:        18\n At this rate you\n       will finish on:  2014-11-26\n Words per day to\n       finish on time:  1369\n```\n\n## Install\n\nYou need [GIT](http://git-scm.com/) and [Python 2.7](https://www.python.org/downloads/release/python-278/)\n(not tested with Python 3+).  For plotting you need\n[matplotlib](http://matplotlib.org/) (but you can still print all the\nstatistics without it).\n\nWith Python and GIT installed, open your terminal window or command\nline. Use the `cd` command to place yourself where you want the program folder\nto end up and do\n\n```\ngit clone https://github.com/Griatch/wordtrack.git\n```\n\nThis will create a new folder `wordtrack` at that location.\n\n## Usage\n\nWordtrack is run from the installation folder, in a terminal/command\nline window.\n\n```\n    python wordtrack [start [days [wordgoal]] | plot | \u003cwordcount\u003e]\n\n       arguments:\n         start  - start a new period, starting from today\n            days - number of days in period (default 30)\n            wordgoal - target # of words (default 50 000)\n         plot - plot your progress (requires matplotlib)\n         \u003cwordcount\u003e - store a new wordcount\n\n      Use without arguments to show current statistics.\n```\n\n\n## Examples\n\nStart a tracking like this:\n\n```\n    python wordtrack.py start\n```\n\nA new file `wordtrack.txt` will appear in the same directory.  This is\nthe ascii data file storing the word counts. It's easily\nhuman-readable and you can also edit past word-counts by editing this\nfile if you should want to. Wordtrack defaults to a time period of 30\ndays and a word-count goal of 50000 words (NaNoWriMo's default). The\nperiod always starts from the current day.\n\nYou can specify other periods and word-goals. To set a period of 20\ndays and a word-goal of 30 000 words, do:\n\n```\n    python wordtrack.py start 20 30000\n```\n\nYou can only have one period running at a time (if you run `start`\nagain, you will start over).\n\nTo start updating your word count, check your text editor for your\ncurrent word count and give it as a number:\n\n```\n    python wordtrack.py \u003cwordcount\u003e\n```\n\nThis registers your current word count and displays the current\nstatistics. You can update as many times as you want in a day, only\nthe latest will be stored.\n\nTo plot (requires matplotlib), use\n\n```\n    python wordtrac.py plot\n```\n\nYou can view the statistics for the current period by calling\nWordtrack without arguments.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgriatch%2Fwordtrack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgriatch%2Fwordtrack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgriatch%2Fwordtrack/lists"}