Metadata-Version: 2.4
Name: obs2nlm
Version: 1.2.0
Summary: Convert Obsidian vaults to NotebookLM sources
Keywords: obsidian,notebooklm,ai,llm,machine-learning
Author: Dave Pearson
Author-email: Dave Pearson <davep@davep.org>
License-Expression: GPL-3.0-or-later
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Information Technology
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.13
Project-URL: Discussions, https://github.com/davep/obs2nlm/discussions
Project-URL: Documentation, https://obs2nlm.davep.dev/
Project-URL: Homepage, https://obs2nlm.davep.dev/
Project-URL: Issues, https://github.com/davep/obs2nlm/issues
Project-URL: Repository, https://github.com/davep/obs2nlm
Project-URL: Source, https://github.com/davep/obs2nlm
Description-Content-Type: text/markdown

# obs2nlm - Make a NotebookLM-friendly source from an Obsidian Vault

`obs2nlm` is a simple command line tool designed to turn an
[Obsidian](https://obsidian.md) vault into a single
[Markdown](https://en.wikipedia.org/wiki/Markdown) file that can be uploaded
to Google's [NotebookLM](https://notebooklm.google.com/) (or presumably used
with other LLM tools for similar purposes).

It's probably fair to say that it's "opinionated" in that I wrote this to
serve my specific purpose; but where possible I've attempted to make it
generic and configurable.

## Installing

`obs2nlm` is a Python application and [is distributed via
PyPI](https://pypi.org/project/obs2nlm/). It can be installed with tools such
as [pipx](https://pipx.pypa.io/stable/):

```sh
pipx install obs2nlm
```

or [`uv`](https://docs.astral.sh/uv/):

```sh
uv tool install obs2nlm
```

Also, if you do have uv installed, you can simply use
[`uvx`](https://docs.astral.sh/uv/guides/tools/):

```sh
uvx obs2nlm
```

to run `obs2nlm`.

## Using

See [the main documentation](https://obs2nlm.davep.dev/) for details on how
to use the tool.

## Getting help

If you need some help using `obs2nlm`, or have ideas for improvements, please
feel free to drop by [the
discussions](https://github.com/davep/obs2nlm/discussions) and ask or
suggest. If you believe you've found a bug please feel free to [raise an
issue](https://github.com/davep/obs2nlm/issues).

[//]: # (README.md ends here)
