Skip to main content

Convert plain text into summaries, notes, flashcards, JSON, topic groups.

Project description

📝 Textnotes

Textnotes is a lightweight Python tool that instantly turns any plain text into meaningful summaries, bullet notes, flashcards, JSON output, and topic groups.
It is designed for anyone who needs quick structured notes — developers, students, writers, and professionals.


🚀 Features

  • 🏷️ Automatic title detection
  • 📝 Clean bullet‑point notes
  • 📄 Instant summaries
  • 📘 JSON output (UTF‑8 safe)
  • 🧠 Flashcards for revision
  • 🗂️ Keyword‑based topic grouping
  • 💻 Use via CLI or python -m textnotes
  • ⚡ Zero dependencies, fast, and simple

📦 Installation

👉 Install from PyPI (after publishing)

pip install textnotes

👉 Install locally from source

pip install -e .

🧰 Usage

▶️ Command-line usage

textnotes "your text here"

▶️ Show help

textnotes --help

▶️ Run as a module

python -m textnotes "your text here"

🖨️Example Output

Input:

python -m textnotes "Python is an amazing programming language used in AI and automation."

Output:

Title: Python Overview
Summary: Python is an amazing programming language used in AI and automation

✨ NOTES:
👉 **Python** is an amazing programming language used in **AI** and automation

📘 JSON:

{
    "title": "Python Overview",
    "summary": "Python is an amazing programming language used in AI and automation",
    "bullets": [
        "👉 **Python** is an amazing programming language used in **AI** and automation"
    ]
}
🎴 FLASHCARDS:
Q: What about this?
A: Python is an amazing programming language used in AI and automation

📂 TOPIC GROUPS:
{'python': ['Python is an amazing programming language used in AI and automation']}

💾 Output saved to file: textnotes_output.txt

🗂️ Project Structure

textnotes/ cli.py processor.py utils.py main.py init.py README.md setup.py LICENSE

🤝 Contributing

Contributions are welcome!

Feel free to open issues or pull requests.

📜 License

Licensed under the MIT License.

⭐ Star the GitHub repository

🤗 Share it with others

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

textnotes-0.1.1.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

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

textnotes-0.1.1-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file textnotes-0.1.1.tar.gz.

File metadata

  • Download URL: textnotes-0.1.1.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for textnotes-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e13c388a1346d1e1cea000e5550a67d448d9e8be781344c935272bee57844793
MD5 9974a613c46b8bd4b40ca16e9f635ba1
BLAKE2b-256 2ac6d536dd53da9e9aaccaab172a240b94e8253908d7cdb13bdfead55c3dfed5

See more details on using hashes here.

File details

Details for the file textnotes-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: textnotes-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for textnotes-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 482d7028e2823ec7a874a314c045893e8f4c4f9f85f0fb16de93c806bd8ffbd8
MD5 0a9943a0f6d7483475f3c8adc8f6acfc
BLAKE2b-256 2498901045d6fec8250f4770ea83528c283aee8ca8422c82cd6dae0b56811f00

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