digger 0.5.0

Digger

A tool to pull annotations from a variety of sources and generate markdown files.

Supported sources:

• Diigo
• Hypothes.is

Badges

Caution

You are welcome to use this tool yourself, however as .Net tools run with full trust you should read the source code and satisfy yourself that it is safe to do so on your machine.

Installing

1. Ensure you have dotnet SDK installed
2. run dotnet tool add -g digger
3. Obtain your Diigo API key
4. Configure Environment variables
5. run the tool digger (see Using)

Updating to latest version

1. run dotnet tool update -g digger

Removing from your system

1. run dotnet tool uninstall -g digger

Environment Variables

Digger requires the following environment variables to be set:

Using

Diigo

1. make sure that any Diigo entries you wish to process are tagged #toprocess
2. run digger diigo -o <relative path to my output directory>
3. for each entry processed a file will be created in the directory you nominated
4. Diigo entries that have been processed will have tag #toprocess removed and tag #processed added
5. edit the resulting files to your taste in the editor of your choosing
6. that's it!

Hypothes.is

1. run digger hypothesis -o <relative path to my output directory> -u <url of source page>
2. a file will be created in the directory you nominated
3. edit the resulting files to your taste in the editor of your choosing

Building

• clone this repo
• run yarn install
• install VS Code
• open working copy
• install all recommended extensions
• install Versionize
• make changes on a branch
• commit using conventional commits

Install from local copy during development

If you want to test a build locally:

dotnet tool uninstall -g digger

And then from root of working copy, after build:

dotnet tool install digger -g --prerelease --add-source ./nupkg

Releasing

• assumes you have nuget installed and configured on your machine with an API key
• git push from branch
• create Pull Request
• review and squash merge
• git checkout master
• git pull origin master
• run versionize
• git push --follow-tags origin master
• dotnet pack
• dotnet nuget push

Contributing

This tool is built first and foremost to solve some irritations I had in my own personal knowledge management processes. However, contributions are welcome, please open an issue first to discuss before creating a pull request.

Please follow the standard Github "contribution by forking" process.

License

This project is licenced under the MIT Licence

Acknowledgements

Initial code to communicate with the Diigo API refactored from DiigoSharp, copyright Ankit Sharma, MIT licence.

This tool also relies heavily on the following third-party libraries (aside from .Net and various standard testing libraries)