Wiesław Palczewski Ph.D.

Oprogramowanie

AddressBookLite ver. 1.0

Lokalna, offline'owa aplikacja do zarządzania danymi adresowymi w plikach .bib, zaprojektowana w duchu TeX-first.

Aktualną wersję programu AddressBookLite ver. 1.0 można pobrać, klikając:
Pobierz

AddressBookLite – instalacja i uruchomienie

AddressBookLite to lokalne, offline'owe narzędzie do zarządzania danymi adresowymi w plikach .bib, zaprojektowane w duchu TeX-first.

1. Zawartość archiwum

Po rozpakowaniu archiwum otrzymasz następującą strukturę:

AddressBookLite/
├── app/        (aplikacja Flask)
├── scripts/    (skrypty start / stop)
├── biblatex/   (style biblatex)
├── examples/   (przykłady .bib i .tex)
├── docs/       (PDF, dokumentacja)
└── README.html

2. Wymagania

  • Python 3.10 lub nowszy
  • Dystrybucja TeX (MiKTeX lub TeX Live)
  • biblatex + biber
  • System Windows, Linux lub macOS

3. Instalacja plików biblatex

Windows (MiKTeX)

C:\Users\<user>\texmf\tex\latex\local\addressbook\

Skopiuj tam pliki:

  • addressbook.bbx
  • addressbook.dbx

Następnie odśwież bazę nazw plików:

initexmf --update-fndb

Linux / macOS

~/texmf/tex/latex/local/addressbook/
mktexlsr

4. Przygotowanie aplikacji

Przejdź do katalogu app/ wewnątrz rozpakowanego archiwum:

cd AddressBookLite\app

Uwaga: środowisko .venv musi być utworzone wewnątrz folderu app\, nie w katalogu głównym AddressBookLite\.

Utwórz środowisko wirtualne:

python -m venv .venv

Aktywuj środowisko:

# Windows (cmd i PowerShell)
.venv\Scripts\activate

# Linux / macOS
source .venv/bin/activate

Zainstaluj zależności:

pip install -r requirements.txt

Aktywacja środowiska jest wymagana tylko przy ręcznym uruchamianiu aplikacji z terminala (punkt 6). Skrypt Start-AddressBookLite.cmd wywołuje Pythona bezpośrednio przez .venv\Scripts\python.exe i nie wymaga uprzedniej aktywacji.

5. Konfiguracja pliku danych

Ścieżkę do pliku .bib podaje się przez zmienną środowiskową:

set "BIBDIR=C:\Users\<user>\texmf\bibtex\bib\addressbook"
set "ADDRESSBOOK_BIB=%BIBDIR%\adresy.bib"

Przykładowy plik znajduje się w katalogu examples/.

6. Uruchomienie aplikacji

Windows

Najprościej kliknąć dwukrotnie plik Start-AddressBookLite.cmd w folderze scripts\.

Można też uruchomić z wiersza poleceń (cmd):

scripts\Start-AddressBookLite.cmd

Uwaga dla użytkowników PowerShell: wejdź do folderu scripts\ i uruchom z przedrostkiem .\:

cd scripts
.\Start-AddressBookLite.cmd

Aby zakończyć działanie:

  • Ctrl+C w oknie serwera lub
  • scripts\Stop-AddressBookLite.cmd

Ręcznie (wszystkie systemy)

python -m flask run

Aplikacja będzie dostępna pod adresem:

http://127.0.0.1:5000

7. Praca z LaTeX

Do wydruku adresów w dokumentach LaTeX użyj:

\printbibliography[
  heading=none,
  type=letter,
  keyword=adresaci
]

Plik .bib jest jedynym trwałym nośnikiem danych.

8. Uwagi końcowe

  • AddressBookLite działa w pełni offline
  • Nie wymaga kont ani usług chmurowych
  • Dane są wersjonowalne (git, backup)

AddressBookLite – installation and usage

AddressBookLite is a local, offline tool for managing address data stored in .bib files, designed in the spirit of TeX-first.

1. Archive contents

After unpacking the archive, you will obtain the following structure:

AddressBookLite/
├── app/        (Flask application)
├── scripts/    (start / stop scripts)
├── biblatex/   (biblatex styles)
├── examples/   (sample .bib and .tex files)
├── docs/       (PDF documentation)
└── README.html

2. Requirements

  • Python 3.10 or newer
  • TeX distribution (MiKTeX or TeX Live)
  • biblatex and biber
  • Windows, Linux, or macOS

3. Installing biblatex style files

Windows (MiKTeX)

C:\Users\<user>\texmf\tex\latex\local\addressbook\

Copy the following files into this directory:

  • addressbook.bbx
  • addressbook.dbx

Then refresh the file name database:

initexmf --update-fndb

Linux / macOS

~/texmf/tex/latex/local/addressbook/
mktexlsr

4. Application setup

Navigate to the app/ directory inside the unpacked archive:

cd AddressBookLite\app

Note: the virtual environment .venv must be created inside the app\ folder, not in the root AddressBookLite\ directory.

Create a virtual environment:

python -m venv .venv

Activate the environment:

# Windows (cmd and PowerShell)
.venv\Scripts\activate

# Linux / macOS
source .venv/bin/activate

Install the required dependencies:

pip install -r requirements.txt

Activating the environment is only required when manually running the application from a terminal (see section 6). The Start-AddressBookLite.cmd script invokes Python directly via .venv\Scripts\python.exe and does not require prior activation.

5. Data file configuration

The path to the .bib data file is provided via an environment variable:

set "BIBDIR=C:\Users\<user>\texmf\bibtex\bib\addressbook"
set "ADDRESSBOOK_BIB=%BIBDIR%\adresy.bib"

A sample .bib file is included in the examples/ directory.

6. Running the application

Windows

The easiest way is to double-click Start-AddressBookLite.cmd in the scripts\ folder.

You can also run it from the command prompt (cmd):

scripts\Start-AddressBookLite.cmd

PowerShell users: navigate into the scripts\ folder first, then prefix with .\:

cd scripts
.\Start-AddressBookLite.cmd

To stop the application:

  • press Ctrl+C in the server window, or
  • run scripts\Stop-AddressBookLite.cmd

Manual start (all platforms)

python -m flask run

The application will be available at:

http://127.0.0.1:5000

7. Using AddressBookLite with LaTeX

To print address data in a LaTeX document, use:

\printbibliography[
  heading=none,
  type=letter,
  keyword=adresaci
]

The .bib file is the only persistent data store used by the system.

8. Final notes

  • AddressBookLite works fully offline
  • No cloud services or user accounts are required
  • All data can be versioned and backed up using standard tools