Define libraries dynamically #851

octvs · 2024-05-15T20:48:35Z

octvs
May 15, 2024

Is it possible to define libraries dynamically, maybe via config.py?
For my use case it would be desirable to define a base_folder under which all dirs can be considered a library.

Answered by alexfikl

May 19, 2024

Hm, yeah, that makes sense. The register_default_settings function just adds things to the default fallback settings which are only seen when using papis.config.get. Libraries unfortunately don't go through that..

For now, you can try this (worked on my system)

import pathlib

basedir = pathlib.Path.home() / 'media' / 'library'
for subdir in basedir.glob('[a-z]*/'):
    libname = subdir.stem
    if libname not in self:
        self.add_section(libname)
    self[libname]['dir'] = str(subdir)

Here self is just the current ConfigParser object that's being initialized. It's a bit hacky, but it should work..

View full answer

alexfikl · 2024-05-17T05:38:21Z

alexfikl
May 17, 2024
Collaborator

I think you should be able to do that in config.py using e.g.

papis.config.register_default_settings({"lib1": {"dir": "some_dir"}, ...})

4 replies

octvs May 18, 2024
Author

Thanks for the reply.

I couldn't make your idea work. I added $XDG_CONFIG_HOME/papis/config.py:

from pathlib import Path

import papis.config

lib_dir = Path.home().joinpath("media", "library")
libs = lib_dir.glob("*/")
libs_conf = {lib.stem: {"dir": str(lib)} for lib in libs}

papis.config.register_default_settings(libs_conf)

As seen my aim is to register all dirs under library as a library to papis.
$XDG_CONFIG_HOME/papis/config looks like this:

[settings]
add-confirm=True
add-edit=True
add-file-name={doc[author_list][0][family]}{doc[year]}
add-folder-name={doc[author_list][0][family]}{doc[year]}
add-open=True
file-browser=lf
fzf-header-format={c.Fore.MAGENTA}{doc[title]:<50.50}{c.Style.RESET_ALL} :: {c.Fore.CYAN}{doc[author]:<20.20}{c.Style.RESET_ALL}{c.Fore.YELLOW}«{doc[year]:4}»{c.Style.RESET_ALL}:{doc[tags]}
notes-name=notes.md
opentool=xdg-open
picktool=fzf
default-library=general

And the result:

$ papis --log INFO open
Error while loading entrypoint 'EntryPoint(name='add', value='papis.commands.add:cli', group='papis.command')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='addto', value='papis.commands.addto:cli', group='papis.command')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='bibtex', value='papis.commands.bibtex:cli', group='papis.command')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='citations', value='papis.commands.citations:cli', group='papis.command')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='explore', value='papis.commands.explore:cli', group='papis.command')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='bibtex', value='papis.bibtex:exporter', group='papis.exporter')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='bibtex', value='papis.bibtex:Importer', group='papis.importer')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='crossref', value='papis.crossref:FromCrossrefImporter', group='papis.importer')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='dblp', value='papis.dblp:Importer', group='papis.importer')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='doi', value='papis.crossref:Importer', group='papis.importer')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='folder', value='papis.commands.add:FromFolderImporter', group='papis.importer')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='lib', value='papis.commands.add:FromLibImporter', group='papis.importer')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='pdf2doi', value='papis.crossref:DoiFromPdfImporter', group='papis.importer')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Error while loading entrypoint 'EntryPoint(name='serve', value='papis.commands.serve:cli', group='papis.command')': Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder.
Traceback (most recent call last):
  File "/nix/store/2dd9jbdigfiwlmyf511hrkr9lqlrgka1-python3.11-papis-0.13/bin/.papis-wrapped", line 9, in <module>
    sys.exit(run())
             ^^^^^
  File "/nix/store/a9illw5w19kdzrl312h10hk39w36xx46-python3.11-click-8.1.7/lib/python3.11/site-packages/click/core.py", line 1157, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/a9illw5w19kdzrl312h10hk39w36xx46-python3.11-click-8.1.7/lib/python3.11/site-packages/click/core.py", line 1077, in main
    with self.make_context(prog_name, args, **extra) as ctx:
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/a9illw5w19kdzrl312h10hk39w36xx46-python3.11-click-8.1.7/lib/python3.11/site-packages/click/core.py", line 943, in make_context
    self.parse_args(ctx, args)
  File "/nix/store/a9illw5w19kdzrl312h10hk39w36xx46-python3.11-click-8.1.7/lib/python3.11/site-packages/click/core.py", line 1644, in parse_args
    rest = super().parse_args(ctx, args)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/a9illw5w19kdzrl312h10hk39w36xx46-python3.11-click-8.1.7/lib/python3.11/site-packages/click/core.py", line 1408, in parse_args
    value, args = param.handle_parse_result(ctx, opts, args)
                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/a9illw5w19kdzrl312h10hk39w36xx46-python3.11-click-8.1.7/lib/python3.11/site-packages/click/core.py", line 2396, in handle_parse_result
    value, source = self.consume_value(ctx, opts)
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/a9illw5w19kdzrl312h10hk39w36xx46-python3.11-click-8.1.7/lib/python3.11/site-packages/click/core.py", line 2934, in consume_value
    value, source = super().consume_value(ctx, opts)
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/a9illw5w19kdzrl312h10hk39w36xx46-python3.11-click-8.1.7/lib/python3.11/site-packages/click/core.py", line 2290, in consume_value
    value = self.get_default(ctx)
            ^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/a9illw5w19kdzrl312h10hk39w36xx46-python3.11-click-8.1.7/lib/python3.11/site-packages/click/core.py", line 2868, in get_default
    return super().get_default(ctx, call=call)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/a9illw5w19kdzrl312h10hk39w36xx46-python3.11-click-8.1.7/lib/python3.11/site-packages/click/core.py", line 2268, in get_default
    value = value()
            ^^^^^^^
  File "/nix/store/2dd9jbdigfiwlmyf511hrkr9lqlrgka1-python3.11-papis-0.13/lib/python3.11/site-packages/papis/commands/default.py", line 144, in <lambda>
    default=lambda: papis.config.getstring("default-library"))
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/2dd9jbdigfiwlmyf511hrkr9lqlrgka1-python3.11-papis-0.13/lib/python3.11/site-packages/papis/config.py", line 387, in getstring
    result = general_get(key, section=section, data_type=str)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/2dd9jbdigfiwlmyf511hrkr9lqlrgka1-python3.11-papis-0.13/lib/python3.11/site-packages/papis/config.py", line 271, in general_get
    libname = get_lib_name()
              ^^^^^^^^^^^^^^
  File "/nix/store/2dd9jbdigfiwlmyf511hrkr9lqlrgka1-python3.11-papis-0.13/lib/python3.11/site-packages/papis/config.py", line 518, in get_lib_name
    return get_lib().name
           ^^^^^^^^^
  File "/nix/store/2dd9jbdigfiwlmyf511hrkr9lqlrgka1-python3.11-papis-0.13/lib/python3.11/site-packages/papis/config.py", line 545, in get_lib
    set_lib_from_name(lib)
  File "/nix/store/2dd9jbdigfiwlmyf511hrkr9lqlrgka1-python3.11-papis-0.13/lib/python3.11/site-packages/papis/config.py", line 470, in set_lib_from_name
    set_lib(get_lib_from_name(libname))
            ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/nix/store/2dd9jbdigfiwlmyf511hrkr9lqlrgka1-python3.11-papis-0.13/lib/python3.11/site-packages/papis/config.py", line 484, in get_lib_from_name
    raise RuntimeError("Library '{0}' does not seem to exist"
RuntimeError: Library 'general' does not seem to exist

To add a library simply write the following in your configuration file located at '$HOME/.config/papis/config'

	[general]
	dir = path/to/your/general/folder

alexfikl May 19, 2024
Collaborator

Hm, yeah, that makes sense. The register_default_settings function just adds things to the default fallback settings which are only seen when using papis.config.get. Libraries unfortunately don't go through that..

For now, you can try this (worked on my system)

import pathlib

basedir = pathlib.Path.home() / 'media' / 'library'
for subdir in basedir.glob('[a-z]*/'):
    libname = subdir.stem
    if libname not in self:
        self.add_section(libname)
    self[libname]['dir'] = str(subdir)

Here self is just the current ConfigParser object that's being initialized. It's a bit hacky, but it should work..

Answer selected by octvs

alexfikl May 19, 2024
Collaborator

#855 should also make it work with register_default_settings.

octvs May 19, 2024
Author

It's a bit hacky, but it should work..

Yes, this works! For later reference here is the current setup:

$ tree library -L 1
library
├── books
├── general
└── thesis

~/.config/papis/config.py

from pathlib import Path

lib_dir = Path.home().joinpath("media", "library")
for subdir in lib_dir.glob("*/"):
    if subdir not in self:
        self.add_section(subdir.stem)
    self[subdir.stem]["dir"] = str(subdir)

~/.config/papis/config is same as above.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Define libraries dynamically #851

{{title}}

Replies: 1 comment 4 replies

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Define libraries dynamically #851

octvs May 15, 2024

Replies: 1 comment · 4 replies

alexfikl May 17, 2024 Collaborator

octvs May 18, 2024 Author

alexfikl May 19, 2024 Collaborator

alexfikl May 19, 2024 Collaborator

octvs May 19, 2024 Author

octvs
May 15, 2024

Replies: 1 comment 4 replies

alexfikl
May 17, 2024
Collaborator

octvs May 18, 2024
Author

alexfikl May 19, 2024
Collaborator

alexfikl May 19, 2024
Collaborator

octvs May 19, 2024
Author