Skip to main content

A package to convert Notion content into Markdown format

Project description

Notion to Markdown (Python Version)

The original author of this work is Wei Xiang, please go to the original repository for more details.

I have only audited the code for usage within my company and made minor changes for compatibility with my code.


This is the Python implementation of nodejs version of notion-to-md, a tool that converts Notion pages into Markdown files.

Installation

Install the package via pip:

pip install notion-to-markdown

Usage

Sync Version

from notion_to_markdown import MarkdownProvider
from notion_client import Client

notion = Client(auth="your-auth-token")
n2m = MarkdownProvider(notion)
md_str = n2m.get_markdown_string("page-id")

with open("output.md", "w") as f:
    f.write(md_str)

Async Version

from notion_client import AsyncClient
from notion_to_markdown import MarkdownProvider

notion = AsyncClient(auth="your-auth-token")
n2m = MarkdownProvider(notion)
md_str = n2m.get_markdown_string_async("page-id")

with open("output.md", "w") as f:
    f.write(md_str)

Replace your-auth-token and page-id with the appropriate values from your Notion account.

Authentication with Notion API

  1. Create an integration in your Notion account and get the API key.
  2. Share your database with the integration to allow access.
  3. Retrieve your Database ID and Page ID from the Notion app.

Requirements

  • Python 3.7 or later
  • Notion API key

Limitations

  • The tool relies on the Notion API, and features are limited to what the API supports.
  • Embedding or downloading files other than images is not supported.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the functionality or fix bugs.

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Submit a pull request with a clear description of your changes.

License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notion_to_markdown-0.1.6.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

notion_to_markdown-0.1.6-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file notion_to_markdown-0.1.6.tar.gz.

File metadata

  • Download URL: notion_to_markdown-0.1.6.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for notion_to_markdown-0.1.6.tar.gz
Algorithm Hash digest
SHA256 84721b9a59e5baff0157672283b16cf16aebdce44cbfe52c7a3f445169f93a0c
MD5 91c6deaabbd988a75d994aa18c915ee8
BLAKE2b-256 96ca52a8f8660a032b104ff6df7a67c1b556506b41b10f01bc90a132386165ab

See more details on using hashes here.

File details

Details for the file notion_to_markdown-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for notion_to_markdown-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4b69bdfced88831778f0f2cfd80c2f5d1ba4e6c82d46c4de69346c7566851f1d
MD5 ac921bd544578666b5e32e3d80ff2e79
BLAKE2b-256 f472f5652f152f3985e704b15589d994373c6869a18e450371e8247e5a3ff377

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page