Skip to content

Commit 0fdf6b1

Browse files
committed
Rename application to lobstersgram
1 parent ee0052b commit 0fdf6b1

15 files changed

Lines changed: 34 additions & 34 deletions

File tree

AGENTS.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Working with This Workspace
22

3-
Lobstergram is a uv-managed Python workspace. Keep changes small, preserve the
3+
Lobstersgram is a uv-managed Python workspace. Keep changes small, preserve the
44
boundaries between the application and reusable packages, and run the checks
55
that cover the code you touched.
66

77
This file is adapted from the [python-package-copier-template AGENTS.md](https://github.com/mgaitan/python-package-copier-template/blob/main/AGENTS.md).
88

99
## Workspace Layout
1010

11-
- `src/lobstergram/` contains the main Telegram application and its
12-
`lobstergram` command-line entrypoint.
11+
- `src/lobstersgram/` contains the main Telegram application and its
12+
`lobstersgram` command-line entrypoint.
1313
- `packages/md-to-telegraph/` contains the reusable Markdown-to-Telegraph
1414
package.
1515
- `packages/markdown-this/` contains the reusable URL/HTML-to-Markdown
@@ -25,7 +25,7 @@ This file is adapted from the [python-package-copier-template AGENTS.md](https:/
2525

2626
```bash
2727
uv sync
28-
uv run lobstergram --help
28+
uv run lobstersgram --help
2929
uv run pytest -q
3030
uv run pytest packages/markdown-this/tests/test_html.py
3131
uv run ruff check .
@@ -35,14 +35,14 @@ uv build --all-packages
3535

3636
The default coverage gate measures `md_to_telegraph` and `markdown_this` at
3737
100%. The application tests run in the same pytest invocation, but the root
38-
configuration does not currently enforce 100% coverage for `lobstergram`.
38+
configuration does not currently enforce 100% coverage for `lobstersgram`.
3939

4040
## Package Boundaries
4141

4242
- Keep Telegram orchestration, configuration, persistence, and runtime state
43-
in `src/lobstergram/`.
43+
in `src/lobstersgram/`.
4444
- Keep reusable conversion and extraction logic in the relevant child package.
45-
- Reusable packages should not import application modules from `lobstergram`.
45+
- Reusable packages should not import application modules from `lobstersgram`.
4646
- Put shared QA configuration in the root `pyproject.toml`; keep package
4747
metadata and package-specific runtime dependencies in the child package's
4848
`pyproject.toml`.
@@ -62,7 +62,7 @@ git push origin markdown-this-v<version>
6262
The reusable packages are published independently. Each publishing workflow
6363
is dedicated to one package: `publish-md-to-telegraph.yml` publishes
6464
`md-to-telegraph`, and `publish-markdown-this.yml` publishes `markdown-this`.
65-
The `lobstergram` application is not published to PyPI yet. A release tag only
65+
The `lobstersgram` application is not published to PyPI yet. A release tag only
6666
activates the matching workflow.
6767

6868
## Editing and Verification

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Lobstergram: Lobsters → Telegraph → Telegram (Serverless)
1+
# Lobstersgram: Lobsters → Telegraph → Telegram (Serverless)
22

33
[![CI](https://github.com/mgaitan/lobstersgram/actions/workflows/ci.yml/badge.svg)](https://github.com/mgaitan/lobstersgram/actions/workflows/ci.yml)
44

5-
Lobstergram is a fast Telegram client for [lobste.rs](https://lobste.rs). It delivers the hottest Lobsters stories (articles that reached the home page) right into Telegram with a clean telegra.ph reading view.
5+
Lobstersgram is a fast Telegram client for [lobste.rs](https://lobste.rs). It delivers the hottest Lobsters stories (articles that reached the home page) right into Telegram with a clean telegra.ph reading view.
66

77
Bot: [@lobstersgram_bot](https://t.me/lobstersgram_bot)
88
Post: https://mgaitan.github.io/en/posts/lobstersgram-cliente-rapido-lobsters/
@@ -13,7 +13,7 @@ Commands:
1313

1414
Demo:
1515

16-
[![Lobstergram demo](https://img.youtube.com/vi/wdzIBFYjJ3Y/hqdefault.jpg)](https://youtube.com/shorts/wdzIBFYjJ3Y?si=yMhLPjz7kDGX_1Wl)
16+
[![Lobstersgram demo](https://img.youtube.com/vi/wdzIBFYjJ3Y/hqdefault.jpg)](https://youtube.com/shorts/wdzIBFYjJ3Y?si=yMhLPjz7kDGX_1Wl)
1717

1818
---
1919

@@ -62,7 +62,7 @@ Create the GitHub release from that tag. The matching publishing workflow
6262
verifies the package version, builds only that package, and publishes it to
6363
PyPI. The reusable packages have separate Trusted Publisher workflows:
6464
`publish-md-to-telegraph.yml` publishes `md-to-telegraph`, and
65-
`publish-markdown-this.yml` publishes `markdown-this`. The `lobstergram`
65+
`publish-markdown-this.yml` publishes `markdown-this`. The `lobstersgram`
6666
application is not published to PyPI yet.
6767

6868
Use the same commands with `md-to-telegraph` as the package name. The tag
@@ -112,7 +112,7 @@ All secrets are stored securely in GitHub Actions.
112112

113113
To register subscribers:
114114
- Send `/start` to the bot from the Telegram account or group you want to receive posts.
115-
- Run the workflow once (or run `uv run lobstergram --read-messages`) to record the
115+
- Run the workflow once (or run `uv run lobstersgram --read-messages`) to record the
116116
`chat_id` values into `subscribers.json`.
117117

118118
For local development, you can set `TELEGRAM_DEV_CHAT_ID` to force all sends

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ requires = ["uv_build>=0.7,<0.12"]
33
build-backend = "uv_build"
44

55
[project]
6-
name = "lobstergram"
6+
name = "lobstersgram"
77
version = "0.1.0"
88
description = "Telegram bot that posts Lobsters links to Telegraph"
99
readme = "README.md"
@@ -20,12 +20,12 @@ dependencies = [
2020
]
2121

2222
[project.urls]
23-
Homepage = "https://github.com/mgaitan/lobstersgram/tree/main/src/lobstergram"
23+
Homepage = "https://github.com/mgaitan/lobstersgram/tree/main/src/lobstersgram"
2424
Repository = "https://github.com/mgaitan/lobstersgram"
2525
Issues = "https://github.com/mgaitan/lobstersgram/issues"
2626

2727
[project.scripts]
28-
lobstergram = "lobstergram.main:main"
28+
lobstersgram = "lobstersgram.main:main"
2929

3030
[tool.uv.workspace]
3131
members = ["packages/md-to-telegraph", "packages/markdown-this"]

src/lobstergram/__init__.py

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/lobstersgram/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"""Lobstersgram: Lobsters → Telegraph → Telegram."""
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
import feedparser
1212
from markdown_this import extract_main_content, fetch_url
1313

14-
from lobstergram import config
15-
from lobstergram.content import Item, collect_new_items
16-
from lobstergram.state import load_state, load_subscribers, save_state, update_message_map
17-
from lobstergram.telegram import read_new_subscribers, resolve_recipient_chat_ids, send_to_recipients
18-
from lobstergram.telegraph import telegraph_create_page
14+
from lobstersgram import config
15+
from lobstersgram.content import Item, collect_new_items
16+
from lobstersgram.state import load_state, load_subscribers, save_state, update_message_map
17+
from lobstersgram.telegram import read_new_subscribers, resolve_recipient_chat_ids, send_to_recipients
18+
from lobstersgram.telegraph import telegraph_create_page
1919

2020

2121
class URLPublishError(RuntimeError):
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import csv
66
import json
77

8-
from lobstergram import config
8+
from lobstersgram import config
99

1010

1111
def load_state() -> dict[str, object]:
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
import requests
1010

11-
from lobstergram import config
12-
from lobstergram.state import load_message_map, load_subscribers, save_subscribers, sync_bookmarks
11+
from lobstersgram import config
12+
from lobstersgram.state import load_message_map, load_subscribers, save_subscribers, sync_bookmarks
1313

1414

1515
class TelegramAPIError(RuntimeError):

0 commit comments

Comments
 (0)