medium2md-cli 0.1.0__tar.gz

medium2md_cli-0.1.0/.gitignore

@@ -0,0 +1,211 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Input directory for Medium export ZIP files (copy your export.zip here)
+input/*
+!input/.gitkeep

medium2md_cli-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

medium2md_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Edgar Bermudez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

medium2md_cli-0.1.0/PKG-INFO

@@ -0,0 +1,237 @@
+Metadata-Version: 2.4
+Name: medium2md-cli
+Version: 0.1.0
+Summary: Convert a Medium export ZIP into Hugo-ready Markdown page bundles with localized images.
+Project-URL: Homepage, https://github.com/edgarbc/medium2md
+Project-URL: Repository, https://github.com/edgarbc/medium2md
+Project-URL: Documentation, https://github.com/edgarbc/medium2md#readme
+Author: Edgar Bermudez
+License: MIT
+License-File: LICENSE
+Keywords: export,hugo,markdown,medium,migration,static-site
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Text Processing :: Markup
+Requires-Python: >=3.13
+Requires-Dist: beautifulsoup4>=4.14.3
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: lxml>=6.0.2
+Requires-Dist: markdownify>=1.2.2
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: python-slugify>=8.0.4
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich>=14.3.3
+Requires-Dist: typer>=0.24.1
+Provides-Extra: dev
+Requires-Dist: twine>=6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# medium2md
+
+[![PyPI version](https://img.shields.io/pypi/v/medium2md-cli.svg)](https://pypi.org/project/medium2md-cli/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/medium2md-cli.svg)](https://pypi.org/project/medium2md-cli/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> Convert a Medium export ZIP into clean, Hugo-ready Markdown page bundles.
+
+**medium2md** is a CLI tool that transforms Medium's HTML export into properly structured [Hugo](https://gohugo.io/) content using page bundles — enabling full ownership of your content and a clean, reproducible migration from Medium to Hugo.
+
+---
+
+## Table of Contents
+
+- [Why This Exists](#why-this-exists)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Output Structure](#output-structure)
+- [Project Structure](#project-structure)
+- [Development Roadmap](#development-roadmap)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+## Why This Exists
+
+Medium allows you to export your account data as a ZIP archive, but the raw export:
+
+- Contains unstructured HTML
+- Includes inconsistent metadata
+- References remote image URLs
+
+**medium2md** solves this by providing:
+
+| Feature | Description |
+|---|---|
+| HTML → Markdown | Converts Medium HTML posts to clean Markdown |
+| Hugo front matter | Generates YAML front matter from post metadata |
+| Image localization | Downloads remote images into each bundle; copies local images when present in the export |
+| Canonical URL | Preserves the original Medium URL |
+| Conversion reports | Summarizes what was converted and what was skipped |
+| Incremental re-runs | *(planned)* Re-run only changed posts |
+
+This tool is designed to be **deterministic**, **reproducible**, and **CI-friendly**.
+
+---
+
+## Features
+
+### MVP (current)
+
+- Convert Medium export ZIP (posts under `posts/` in the export)
+- Extract title and canonical URL; generate slug
+- Convert HTML to Markdown
+- Create Hugo page bundles with `index.md` and optional `images/`
+- Image localization: download remote images into the bundle; copy local images when present in the export
+- Basic slug collision handling (`slug-2`, `slug-3`, …)
+- Terminal progress and summary; per-post image count; prompt to create missing output dir
+
+### Planned
+
+- Extract date and optional metadata (tags, etc.) into front matter
+- Incremental runs via state file
+- Embed detection and shortcode conversion (YouTube, Twitter, Gist)
+- Pandoc backend option
+- Verification command
+- Theme-specific front matter mapping
+- Conversion report (e.g. JSON/file)
+
+---
+
+## Installation
+
+This project uses [uv](https://github.com/astral-sh/uv) for dependency management.
+
+```bash
+git clone https://github.com/edgarbc/medium2md.git
+cd medium2md
+uv sync
+```
+
+Once published to PyPI, install with:
+
+```bash
+pip install medium2md-cli
+# or with uv:
+uv tool install medium2md-cli
+```
+
+The CLI command is still `medium2md`.
+
+---
+
+## Usage
+
+Copy your Medium export ZIP into the `input/` directory (already set up and git-ignored):
+
+```bash
+cp ~/Downloads/medium-export.zip input/
+uv run medium2md input/medium-export.zip --out ../blog/content/posts
+```
+
+> **Note:** The `input/` directory is tracked by git (via `.gitkeep`) so it exists after a fresh clone, but its contents are ignored — your ZIP files will never be accidentally committed.
+
+### Front Matter Example
+
+Each converted post produces an `index.md` with Hugo-compatible YAML front matter. Current output:
+
+```yaml
+---
+title: "My Post Title"
+draft: true
+slug: "my-post-slug"
+medium:
+  canonical: "https://medium.com/@you/post-slug"
+---
+```
+
+Additional keys (e.g. `date`, `lastmod`, `tags`) are planned.
+
+---
+
+## Output Structure
+
+Each Medium post becomes a Hugo page bundle. Image links in the Markdown point into the bundle’s `images/` folder (remote images are downloaded; local images from the export are copied):
+
+```
+content/posts/
+└── my-post-slug/
+    ├── index.md
+    └── images/
+        ├── 1.png
+        ├── 2.jpg
+        └── …
+```
+
+---
+
+## Project Structure
+
+```
+medium2md/
+├── medium2md/
+│   ├── __init__.py
+│   ├── cli.py
+│   ├── pipeline.py
+│   └── main.py
+├── pyproject.toml
+├── README.md
+├── project-plan.md
+└── input/
+    └── medium-export.zip
+```
+
+### Pipeline Architecture
+
+medium2md follows a layered pipeline:
+
+```
+ZIP → extract → find posts → parse HTML → localize images (copy/download) → Markdown conversion → front matter + Hugo bundle write
+```
+
+> **Philosophy:** Correctness first, cleverness later.
+
+---
+
+## Development Roadmap
+
+| Milestone | Focus | Status |
+|---|---|---|
+| 1 — MVP | ZIP ingestion, HTML→Markdown, Hugo bundle writing, image localization | ✅ Done |
+| 2 — Robustness | Incremental state tracking, metadata fallback, verify command | 📋 Planned |
+| 3 — Polish | Embed conversion, theme config mapping, Pandoc backend, internal link rewriting | 📋 Planned |
+
+---
+
+## Contributing
+
+Contributions are welcome! To get started:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feat/my-feature`)
+3. Make your changes
+4. Open a pull request (run `uv run medium2md --help` to confirm the CLI works)
+
+---
+
+## Publishing to PyPI (maintainers)
+
+1. Bump `version` in `pyproject.toml`.
+2. Build: `uv build` (creates `dist/`).
+3. Install dev deps and upload: `uv sync --extra dev` then `uv run twine upload dist/*` (requires a [PyPI API token](https://pypi.org/help/#apitoken); use `__token__` as username).
+4. Optionally tag the release: `git tag v0.1.0 && git push --tags`.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+---
+
+> Built by [Edgar Bermudez](https://github.com/edgarbc) and [GitHub Copilot](https://github.com/features/copilot) with 💖 to enable long-term content ownership and reproducible publishing workflows.
+>
+> Not affiliated with Medium or any of its subsidiaries.

medium2md_cli-0.1.0/README.md

@@ -0,0 +1,205 @@
+# medium2md
+
+[![PyPI version](https://img.shields.io/pypi/v/medium2md-cli.svg)](https://pypi.org/project/medium2md-cli/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/medium2md-cli.svg)](https://pypi.org/project/medium2md-cli/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> Convert a Medium export ZIP into clean, Hugo-ready Markdown page bundles.
+
+**medium2md** is a CLI tool that transforms Medium's HTML export into properly structured [Hugo](https://gohugo.io/) content using page bundles — enabling full ownership of your content and a clean, reproducible migration from Medium to Hugo.
+
+---
+
+## Table of Contents
+
+- [Why This Exists](#why-this-exists)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Output Structure](#output-structure)
+- [Project Structure](#project-structure)
+- [Development Roadmap](#development-roadmap)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+## Why This Exists
+
+Medium allows you to export your account data as a ZIP archive, but the raw export:
+
+- Contains unstructured HTML
+- Includes inconsistent metadata
+- References remote image URLs
+
+**medium2md** solves this by providing:
+
+| Feature | Description |
+|---|---|
+| HTML → Markdown | Converts Medium HTML posts to clean Markdown |
+| Hugo front matter | Generates YAML front matter from post metadata |
+| Image localization | Downloads remote images into each bundle; copies local images when present in the export |
+| Canonical URL | Preserves the original Medium URL |
+| Conversion reports | Summarizes what was converted and what was skipped |
+| Incremental re-runs | *(planned)* Re-run only changed posts |
+
+This tool is designed to be **deterministic**, **reproducible**, and **CI-friendly**.
+
+---
+
+## Features
+
+### MVP (current)
+
+- Convert Medium export ZIP (posts under `posts/` in the export)
+- Extract title and canonical URL; generate slug
+- Convert HTML to Markdown
+- Create Hugo page bundles with `index.md` and optional `images/`
+- Image localization: download remote images into the bundle; copy local images when present in the export
+- Basic slug collision handling (`slug-2`, `slug-3`, …)
+- Terminal progress and summary; per-post image count; prompt to create missing output dir
+
+### Planned
+
+- Extract date and optional metadata (tags, etc.) into front matter
+- Incremental runs via state file
+- Embed detection and shortcode conversion (YouTube, Twitter, Gist)
+- Pandoc backend option
+- Verification command
+- Theme-specific front matter mapping
+- Conversion report (e.g. JSON/file)
+
+---
+
+## Installation
+
+This project uses [uv](https://github.com/astral-sh/uv) for dependency management.
+
+```bash
+git clone https://github.com/edgarbc/medium2md.git
+cd medium2md
+uv sync
+```
+
+Once published to PyPI, install with:
+
+```bash
+pip install medium2md-cli
+# or with uv:
+uv tool install medium2md-cli
+```
+
+The CLI command is still `medium2md`.
+
+---
+
+## Usage
+
+Copy your Medium export ZIP into the `input/` directory (already set up and git-ignored):
+
+```bash
+cp ~/Downloads/medium-export.zip input/
+uv run medium2md input/medium-export.zip --out ../blog/content/posts
+```
+
+> **Note:** The `input/` directory is tracked by git (via `.gitkeep`) so it exists after a fresh clone, but its contents are ignored — your ZIP files will never be accidentally committed.
+
+### Front Matter Example
+
+Each converted post produces an `index.md` with Hugo-compatible YAML front matter. Current output:
+
+```yaml
+---
+title: "My Post Title"
+draft: true
+slug: "my-post-slug"
+medium:
+  canonical: "https://medium.com/@you/post-slug"
+---
+```
+
+Additional keys (e.g. `date`, `lastmod`, `tags`) are planned.
+
+---
+
+## Output Structure
+
+Each Medium post becomes a Hugo page bundle. Image links in the Markdown point into the bundle’s `images/` folder (remote images are downloaded; local images from the export are copied):
+
+```
+content/posts/
+└── my-post-slug/
+    ├── index.md
+    └── images/
+        ├── 1.png
+        ├── 2.jpg
+        └── …
+```
+
+---
+
+## Project Structure
+
+```
+medium2md/
+├── medium2md/
+│   ├── __init__.py
+│   ├── cli.py
+│   ├── pipeline.py
+│   └── main.py
+├── pyproject.toml
+├── README.md
+├── project-plan.md
+└── input/
+    └── medium-export.zip
+```
+
+### Pipeline Architecture
+
+medium2md follows a layered pipeline:
+
+```
+ZIP → extract → find posts → parse HTML → localize images (copy/download) → Markdown conversion → front matter + Hugo bundle write
+```
+
+> **Philosophy:** Correctness first, cleverness later.
+
+---
+
+## Development Roadmap
+
+| Milestone | Focus | Status |
+|---|---|---|
+| 1 — MVP | ZIP ingestion, HTML→Markdown, Hugo bundle writing, image localization | ✅ Done |
+| 2 — Robustness | Incremental state tracking, metadata fallback, verify command | 📋 Planned |
+| 3 — Polish | Embed conversion, theme config mapping, Pandoc backend, internal link rewriting | 📋 Planned |
+
+---
+
+## Contributing
+
+Contributions are welcome! To get started:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feat/my-feature`)
+3. Make your changes
+4. Open a pull request (run `uv run medium2md --help` to confirm the CLI works)
+
+---
+
+## Publishing to PyPI (maintainers)
+
+1. Bump `version` in `pyproject.toml`.
+2. Build: `uv build` (creates `dist/`).
+3. Install dev deps and upload: `uv sync --extra dev` then `uv run twine upload dist/*` (requires a [PyPI API token](https://pypi.org/help/#apitoken); use `__token__` as username).
+4. Optionally tag the release: `git tag v0.1.0 && git push --tags`.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+---
+
+> Built by [Edgar Bermudez](https://github.com/edgarbc) and [GitHub Copilot](https://github.com/features/copilot) with 💖 to enable long-term content ownership and reproducible publishing workflows.
+>
+> Not affiliated with Medium or any of its subsidiaries.