https://github.com/naps62/timetrap_toggl
https://github.com/naps62/timetrap_toggl
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/naps62/timetrap_toggl
- Owner: naps62
- Created: 2016-11-02T18:47:36.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-21T14:14:16.000Z (over 9 years ago)
- Last Synced: 2025-03-31T02:22:00.700Z (over 1 year ago)
- Language: Ruby
- Size: 18.6 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# timetrap-toggl
A Toggl formatter for Timetrap
`timetrap-toggl` allows you to submit your timetrap timesheets to [Toggl](https://toggl.com/).
__timetrap-toggl__'s initial development was sponsored by [dscout](https://dscout.com). Many thanks to them!
## Usage
```bash
# Reference one of your toggl project task aliases within an entry's note:
$ timetrap in working on timetrap-toggl @code
$ timetrap out
# display the entries you wish to submit using the toggl formatter:
$ timetrap display --start 'last monday' --end 'last friday' --format toggl
```
## Installation
```bash
$ gem install timetrap_toggl
$ echo "require 'timetrap_toggl'" > ./path/to/formatters/toggl.rb
```
## Configuration
```yaml
# ~/.timetrap.yml
---
...
toggl:
api_token: "YOUR_API_TOKEN"
workspace: "My workspace"
```
The gem will find all the projects in the given workspace, and match them with
the tags you add to your tasks. Here's a correspondence of examples of Toggl
project names, and the corresponding tags you should use:
* `ProjectName`: `@projectname` (matching is case-insensitive)
* `Marketing & Communication`: `@marketing-communication` (special characters
and spaces are replaced with dashes)
## Dependencies
timetrap-toggl depends upon the timetrap gem
When installing timetrap-toggl, timetrap is installed for you as a runtime
dependency.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Thanks
* [dblandin](https://github.com/dblandin) for creating timetrap-harvest, which
was the basis for this one