{"id":18127811,"url":"https://github.com/lelutin/scout","last_synced_at":"2025-04-15T07:30:41.217Z","repository":{"id":730004,"uuid":"378973","full_name":"lelutin/scout","owner":"lelutin","description":"CLI interface to Tomboy and Gnote","archived":false,"fork":false,"pushed_at":"2024-06-10T06:05:48.000Z","size":382,"stargazers_count":24,"open_issues_count":10,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T18:11:14.520Z","etag":null,"topics":["cli-interface","gnote","notes","tomboy"],"latest_commit_sha":null,"homepage":"","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/lelutin.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2009-11-20T00:23:37.000Z","updated_at":"2024-06-10T06:05:51.000Z","dependencies_parsed_at":"2024-11-01T09:52:25.431Z","dependency_job_id":null,"html_url":"https://github.com/lelutin/scout","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lelutin%2Fscout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lelutin%2Fscout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lelutin%2Fscout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lelutin%2Fscout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lelutin","download_url":"https://codeload.github.com/lelutin/scout/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249026638,"owners_count":21200479,"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":["cli-interface","gnote","notes","tomboy"],"created_at":"2024-11-01T09:42:13.388Z","updated_at":"2025-04-15T07:30:40.887Z","avatar_url":"https://github.com/lelutin.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scout\n\nScout : A CLI interface to Tomboy notes and Gnote\n\nScout is an interface to Tomboy notes or Gnote that uses DBus to\ncommunicate. It presents a command-line interface and\ntries to be as simple to use as possible. Different actions\ncan be taken to interact with Tomboy or Gnote. Actions are simple\nto create, making the application easily extensible.\n\nCurrent actions make it possible to list note names, display note contents,\nsearch for text inside notes and to delete notes.\n\n## Use\n\nTo use scout the first argument must be an action name. For example, say you\nwant to get a list of all non-template notes. You can call the following:\n\n    scout list\n\nArguments can be given to actions. The arguments available differ from one\naction to the other. For example,\nthe \"search\" action requires an element to search for:\n\n    scout search \"text to search for\"\n\nYou can obtain help on how to execute scout by giving it a \"-h\" or \"--help\"\nargument. This will list the currently available actions you can use with\nscout. To obtain more detail on what arguments can be used with an action, use\nthe option \"-h\" or \"--help\" and specify an action name at the same time. Both\nof the two following commands call the detailed help for the action \"display\":\n\n    scout --help display\n    # or:\n    scout display -h\n\n### Choosing the note application\n\nScout can be used with either Tomboy or Gnote. Scout detects which one of\nthem is currently installed. If only one of them is present, it will\nautomatically connect to it.\n\nHowever, in a context where both Tomboy and Gnote are installed, Scout cannot\ndetermine which one to use unless it is specified as an argument to the command\nline or in a configuration file.\n\nA system-wide configuration file can be placed in `/etc/scout.cfg`. Each\nuser can also create a configuration file in their home directory (e.g. either\n`~/.scout/config` or `~/.config/scout/config`). Values in the user\nconfiguration file will override those set in the system-wide configuration.\nThe configuration file should follow the Windows INI file format. To select the\napplication, the \"application\" option in the \"scout\" section should be set to\neither Tomboy or Gnote. Ex. (Tomboy):\n\n    [scout]\n    application: Tomboy\n\nThe command line argument takes precedence over the value set in the\nconfiguration file. Here's how to list notes from Gnote:\n\n    scout list --application=Gnote\n\n## Requirements\n\nYou need to have `libdbus` installed in order for the `dbus-python` library to\nbe useful. In theory, though if you have already installed Tomboy or Gnote\nbeforehand you should already have this library on your system.\n\nYou also need your note application to be running, otherwise you might be\ngetting errors about the dbus interface not existing.\n\nAlso, for pip to be able to install `dbus-python`, you need dev libraries to be\npresent on your system. In debian you can install them with:\n\n    sudo apt install libdbus-1-dev libdbus-glib-1-dev\n\n## Installing from source\n\nThis project is setup to be used with `pip` so you can install it and/or build\na wheel as you would normally do with that tool.\n\nTo see a short summary of what has changed between versions, consult the\n[changelog wiki page][ChangeLog].\n\n## Contributing\n\nAll contributions to the code are welcome. Contributed code should come with\nnew unit tests for added functions and new or modified acceptance tests for\ncommand line interface modifications. The main repository is on [GitHub]. Send\npatches to the [mailing list] (See the section about the list for more\ndetails).\n\nCommit messages should contain a \"Signed-off-by:\" line with you name and e-mail\naddress, in the same fashion as contributions to git or the Linux kernel. This\nline attests that you are willing to license your code under the same license\nas the one used by the project (e.g. BSD). To add such a line with git, use the\n\"-s\" argument to git-commit.\n\n## Development environment\n\nThe recommended way to have a development environement is to create a python\nvirtualenv as shown below:\n\n    python3 -m venv ve\n    source ve/bin/activate\n\nThen in the venv install scout in \"develop\" mode and its dependencies with pip\nso that you can test it while developing:\n\n    pip install -e .[test]\n\n## Tests\n\ntests are run using pytest. From the base directory, with the venv activated:\n\n    pytest\n\nYou can disable running the functional (or integration) tests by filtering out\nthe marker (or by dropping the \"not\", run only those tests):\n\n    pytest -m \"not integration\"\n\n## License\n\nScout can be used, distributed and modified. All files are under a BSD-4-clause\nlicense.\n\nA copy of the BSD license should be available with the source code. Also, a\nshort license notice can be found in all files.\n\n[Github]: https://github.com/lelutin/scout\n[ChangeLog]:https://github.com/lelutin/scout/wiki/ChangeLog\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flelutin%2Fscout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flelutin%2Fscout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flelutin%2Fscout/lists"}