Metadata-Version: 2.1
Name: tilly
Version: 0.0.5
Summary: A cli for tracking Things I Learned (TIL)
Home-page: https://github.com/tilly-pub/tilly
Author: Ronald Luitwieler
Author-email: ronald.luitwieler@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.0
Requires-Dist: pluggy>=1.0
Requires-Dist: setuptools
Requires-Dist: GitPython
Requires-Dist: sqlite-utils>=3.2
Requires-Dist: beautifulsoup4
Requires-Dist: httpx
Requires-Dist: datasette>=0.65.1
Requires-Dist: datasette-template-sql>=1.0.2

# tilly

CLI for easily creating Today I Learned posts.


## Installation

```
uv venv .venv
source .venv/bin/activate
uv pip install tilly
```

## Usage

Create a repo (or clone a repo from github):

```
git init
```

Add a TIL:

```
mkdir example # this will be the topic of your TIL.
echo "# My first TIL with tilly" > example/first-til.md
```

Commit your work:

```
git add .
git commit -m "adding first til"
```

Build the local `tils.db`:

```
tilly build
```

Serve you tils locally:

```
tilly serve
```

Generate a static site in the docs folder:

```
tilly config -l --output-folder docs
tilly gen-static
```

The static site can also be served locally:

```
tilly serve --static
```

You can now publish your static site to [Github](https://pages.github.com).
Don't forget to configure the source folder `docs` in your repository's GitHub Pages settings.


## Customize the default templates

Your can overwrite the default templates by first making a copy of the default templates:

```
tilly copy-templates
```

Change the templates to your liking, then generate your static site:

```
tilly gen-static --template-dir templates
```

Customized templates can also be served locally:

```
tilly serve --template-dir templates
```


## Creating plugins

TODO

## Development, building and publishing

```
uv venv .venv --python=3.11
source .venv/bin/activate
uv pip install .
uv pip install -r requirements-dev.txt
./build.sh
./publish.sh
```
