Metadata-Version: 2.4
Name: aardvark-jd
Version: 0.1.3
Summary: A PARA + Johnny Decimal filing and indexing system, backed by SQLite
Author-email: David Young <david.young.rse@gmail.com>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/thespacedoctor/aardvark-jd
Keywords: para,johnny-decimal,filing,knowledge-management,cli
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Utilities
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyyaml
Requires-Dist: fundamentals
Requires-Dist: docopt
Requires-Dist: emoji
Provides-Extra: docs
Requires-Dist: build; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-autodoc2; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: furo; extra == "docs"
Requires-Dist: sphinx-inline-tabs; extra == "docs"
Requires-Dist: sphinxext-opengraph; extra == "docs"
Requires-Dist: sphinx-autobuild; extra == "docs"
Requires-Dist: linkify-it-py; extra == "docs"
Requires-Dist: sphinxcontrib-mermaid; extra == "docs"
Requires-Dist: sphinx-togglebutton; extra == "docs"
Requires-Dist: sphinx_copybutton; extra == "docs"
Requires-Dist: sphinx_tippy; extra == "docs"
Requires-Dist: sphinx_design; extra == "docs"
Requires-Dist: pygments-csv-lexer; extra == "docs"
Requires-Dist: sphinxcontrib-svg2pdfconverter; extra == "docs"
Requires-Dist: sphinx-remove-toctrees; extra == "docs"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: nose2; extra == "tests"
Provides-Extra: dev
Requires-Dist: aardvark-jd[docs,tests]; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# aardvark-jd

<!-- INFO BADGES -->  

[![](https://img.shields.io/pypi/pyversions/aardvark-jd)](https://pypi.org/project/aardvark-jd/)
[![](https://img.shields.io/pypi/v/aardvark-jd)](https://pypi.org/project/aardvark-jd/)
[![](https://img.shields.io/conda/vn/conda-forge/aardvark-jd)](https://anaconda.org/conda-forge/aardvark-jd)
[![](https://pepy.tech/badge/aardvark-jd)](https://pepy.tech/project/aardvark-jd)
[![](https://img.shields.io/github/license/thespacedoctor/aardvark-jd)](https://github.com/thespacedoctor/aardvark-jd)

<!-- STATUS BADGES -->  

[![](https://soxs-eso-data.org/ci/buildStatus/icon?job=aardvark-jd%2Fmain&subject=build%20main)](https://soxs-eso-data.org/ci/blue/organizations/jenkins/aardvark-jd/activity?branch=main)
[![](https://soxs-eso-data.org/ci/buildStatus/icon?job=aardvark-jd%2Fdevelop&subject=build%20dev)](https://soxs-eso-data.org/ci/blue/organizations/jenkins/aardvark-jd/activity?branch=develop)
[![](https://cdn.jsdelivr.net/gh/thespacedoctor/aardvark-jd@main/coverage.svg)](https://raw.githack.com/thespacedoctor/aardvark-jd/main/htmlcov/index.html)
[![](https://readthedocs.org/projects/aardvark-jd/badge/?version=main)](https://aardvark-jd.readthedocs.io/en/main/)
[![](https://img.shields.io/github/issues/thespacedoctor/aardvark-jd/type:%20bug?label=bug%20issues)](https://github.com/thespacedoctor/aardvark-jd/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22+)

*A PARA + Johnny Decimal filing and indexing system, backed by SQLite*. Installs as the `aardvark-jd` package; the command-line tool itself is called `aardvark`.

Documentation for aardvark is hosted by [Read the Docs](https://aardvark-jd.readthedocs.io/en/main/) ([development version](https://aardvark-jd.readthedocs.io/en/develop/) and [main version](https://aardvark-jd.readthedocs.io/en/main/)). The code lives on [github](https://github.com/thespacedoctor/aardvark-jd). Please report any issues you find [here](https://github.com/thespacedoctor/aardvark-jd/issues). If you want to contribute, [pull requests](https://github.com/thespacedoctor/aardvark-jd/pulls) are welcomed!


## Features

* `init` a PARA + Johnny Decimal root folder structure, indexed in a local SQLite database
* `add-area` / `add-category` / `add-id` to grow the Johnny Decimal index under Areas or Resources, with auto-numbering
* `new-project` to spin up a new (optionally templated) project folder under Projects
* `search` the index by keyword or phrase
* every non-ID folder is automatically suffixed with a relevant emoji



## Installation

The easiest way to install aardvark is to use `conda`:

``` bash
conda create -n aardvark-jd python=3.14 pip aardvark-jd -c conda-forge
conda activate aardvark-jd
```

To upgrade to the latest version of aardvark use the command:

``` bash
conda upgrade aardvark-jd -c conda-forge
```

It is also possible to install via pip if required:

``` bash
pip install aardvark-jd
```

Or you can clone the [github repo](https://github.com/thespacedoctor/aardvark-jd) and install from a local version of the code:

``` bash
git clone git@github.com:thespacedoctor/aardvark-jd.git
cd aardvark-jd
python setup.py install
```

To check installation was successful run `aardvark -v`. This should return the version number of the install.

## Initialising a system

Give your system a name and a parent folder to live in:

```bash
aardvark init "My Life" ~/
```

This builds the full PARA + Johnny Decimal folder tree, creates the `aardvark.db` SQLite index, and records the system as active in your user settings file at `~/.config/aardvark/aardvark.yaml` (created automatically on first run, populated with aardvark's default settings).

You are now ready to start using aardvark - see the [quickstart](https://aardvark-jd.readthedocs.io/en/main/quickstart.html) for the full command reference.
