Skip to content

Commit

Permalink
Update readme and requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
mfarragher committed Oct 19, 2021
1 parent 8d714fa commit 100b66d
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ This is how **`obsidiantools`** can complement your workflows for note-taking:
- **Retrieve detail about your notes' links and metadata as built-in Python types**
- The various types of links:
- Wikilinks (incl. header links, links with alt text)
- Embedded files
- Backlinks
- Markdown links
- You can access all the links in one place, or you can load them for an individual note:
Expand All @@ -51,13 +52,18 @@ Developed for Python 3.9 but may still work on lower versions.
As of Sep 2021, NetworkX requires Python 3.7 or higher (similar for Pandas too) so that is recommended as a minimum.

## 🖇️ Dependencies
- markdown
- html2text
- pandas
- numpy
- networkx
- python-frontmatter
- beautifulsoup4
- Main libraries:
- markdown
- html2text
- pandas
- numpy
- networkx
- Libraries for parsing front matter:
- python-frontmatter
- beautifulsoup4
- lxml

All of these libraries are needed so that the package can separate note text from front matter in a generalised approach.

## 🏗️ Tests
A small 'dummy vault' vault of lipsum notes is in `tests/vault-stub` (generated with help of the [lorem-markdownum](https://github.com/jaspervdj/lorem-markdownum) tool). Sense-checking on the API functionality was also done on a personal vault of up to 100 notes.
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ numpy
networkx
python-frontmatter
beautifulsoup4
lxml # front matter parsing
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
"numpy",
"networkx",
"python-frontmatter",
"beautifulsoup4"]
"beautifulsoup4",
"lxml"]

CLASSIFIERS = [
"Development Status :: 3 - Alpha",
Expand Down

0 comments on commit 100b66d

Please sign in to comment.