Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,4 @@ blog/dsa/leetcode/calendar_2/_oops_files/
.env.actions
blog/posts/keywords/*.svg
blog/build-prod
blog/posts/**/*.svg
54 changes: 47 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ To see coverage reports, got see [the artifacts on github pages](https://acederb

# Running

For all set ups, make the configuration dir ``config`` and provide your kaggle
configuration in ``config/kaggle/kaggle.json``.
For all set ups, make the configuration dir ``config`` and provide the kaggle
configuration in ``config/kaggle/kaggle.json``:

```bash
mkdir config/kaggle -p
```


## With Docker Compose
Expand All @@ -23,17 +27,53 @@ This will provide access to ``quarto``, ``python``, and ``r``.

## The Hard Way

First, ensure that ``quarto`` is installed. Then setup a virtual environment and
add install the dependencies using ``poetry``:
First, ensure that ``quarto>=1.6`` is installed. Then set up a virtual
environment using `pyenv` and add install the dependencies using ``poetry``:

```bash
python -m venv .venv
source .venv/bin/activate
python -m pip install poetry
# Add python 3.11
pyenv install 3.11

# Create a virual environment
pyenv virtualenv 3.11 blog

# Make sure that the executables are seen
export PATH=$PATH:$VIRTUAL_ENV/bin

# Verify python version. Should be under ``~/.pyenv``
which python
which pip

# Install poetry
pip install poetry

# Install with poetry
poetry install

# Run the development server
acederbergio serve dev
```


# Editing

In theory this should work but I am yet to do this myself. So be aware this is
only roughly the process of setting up neovim to play nice with the project
and virtual environment.

```bash
# Create an ipython kernel. This is necessary to use `molten.nvim` inside of
# neovim. It neads `pynvim` to be setup correctly.
poetry run pip install pynvim
poetry run python -m ipykernal install --user --name blog

git clone https://github.com/acederberg/nvim-ez --output=~/.config/nvim
```

Next, open `neovim` and run `:Lazy` in normal and then install the dependencies
by hitting `I`.


# Building

To render the website, just
Expand Down
4 changes: 3 additions & 1 deletion acederbergio/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@

from acederbergio.api.main import cli as cli_server
from acederbergio.api.quarto import cli as cli_quarto
from acederbergio.pdf import cli as cli_pdf
from acederbergio.bucket import cli as cli_bucket
from acederbergio.config import cli as cli_config
from acederbergio.db import cli as cli_db
from acederbergio.docs import cli as cli_docs
from acederbergio.env import cli as cli_env
from acederbergio.filters.__main__ import cli as cli_filters
from acederbergio.iconify import cli as cli_iconify_kubernetes
from acederbergio.pdf import cli as cli_pdf
from acederbergio.verify import cli as cli_verify

cli = typer.Typer(pretty_exceptions_enable=False)
cli.add_typer(cli_bucket, name="bucket")
cli.add_typer(cli_pdf, name="pdf")
cli.add_typer(cli_quarto, name="quarto")
cli.add_typer(cli_server, name="serve")
Expand Down
Loading