rfc-editor 0.1.0.1__tar.gz

rfc_editor-0.1.0.1/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: rfc-editor
+Version: 0.1.0.1
+Summary: A Python library to parse and edit RFC TXT documents
+Author-email: RFC Editor Team <team@rfc-editor.example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/example/rfc-editor
+Project-URL: Repository, https://github.com/example/rfc-editor
+Keywords: rfc,editor,document,ietf
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: flake8>=6.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+
+# RFC Editor Library
+
+A Python library for parsing and editing RFC (Request for Comments) TXT documents.
+
+## Features
+
+- Parse RFC TXT documents and extract all sections
+- Edit all RFC document sections including:
+  - Title
+  - Abstract
+  - Status of This Memo
+  - Copyright Notice
+  - Table of Contents
+  - Numbered sections (1., 2., etc.)
+  - Acknowledgements
+  - Contributors
+  - Author's Address
+- Add, update, and delete sections
+- Save modified documents back to TXT format
+
+## Installation
+
+```bash
+pip install rfc-editor
+```
+
+Or install from source:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+### Parse an RFC Document
+
+```python
+from rfc_editor import RFCEditor
+
+editor = RFCEditor()
+doc = editor.load("rfc1234.txt")
+
+# Or parse from string
+doc = editor.parse(rfc_content_string)
+```
+
+### Access Document Sections
+
+```python
+print(doc.rfc_number)  # RFC number
+print(doc.category)   # e.g., "Standards Track"
+print(doc.title)      # RFC title
+print(doc.abstract)  # Abstract content
+```
+
+### Edit Sections
+
+```python
+# Edit title
+editor.set_title("New Title")
+
+# Edit abstract
+editor.set_abstract("New abstract content...")
+
+# Edit status
+editor.set_status_of_memo("New status content...")
+
+# Edit copyright
+editor.set_copyright(2024, "Example Corp")
+
+# Edit TOC
+editor.set_toc("1. Introduction\n2. Body")
+
+# Update a numbered section
+editor.update_section("1", content="Updated introduction content...")
+
+# Add a new section
+editor.add_section("5", "New Section", "Section content...")
+
+# Delete a section
+editor.delete_section("1")
+
+# Edit by section title
+editor.set_section_by_title("Introduction", "New content...")
+```
+
+### Save the Document
+
+```python
+editor.save("output.txt")
+```
+
+### Convert to Dictionary
+
+```python
+data = editor.to_dict()
+print(data["title"])
+print(data["sections"])
+```
+
+## Development
+
+### Install Dev Dependencies
+
+```bash
+pip install -e ".[dev]"
+```
+
+### Run Tests
+
+```bash
+pytest tests/
+```
+
+### Run Linting
+
+```bash
+flake8 src/ tests/
+ruff check src/ tests/
+black --check src/ tests/
+```
+
+## Project Structure
+
+```
+rfc-editor/
+├── src/
+│   └── rfc_editor/
+│       └── __init__.py    # Main library code
+├── tests/
+│   ├── test_author.py
+│   ├── test_document.py
+│   ├── test_editor.py
+│   └── test_section.py
+├── pyproject.toml
+├── README.md
+├── .gitignore
+└── SPEC.md
+```
+
+## Version
+
+0.1.0.1
+
+## License
+
+MIT

rfc_editor-0.1.0.1/README.md

@@ -0,0 +1,147 @@
+# RFC Editor Library
+
+A Python library for parsing and editing RFC (Request for Comments) TXT documents.
+
+## Features
+
+- Parse RFC TXT documents and extract all sections
+- Edit all RFC document sections including:
+  - Title
+  - Abstract
+  - Status of This Memo
+  - Copyright Notice
+  - Table of Contents
+  - Numbered sections (1., 2., etc.)
+  - Acknowledgements
+  - Contributors
+  - Author's Address
+- Add, update, and delete sections
+- Save modified documents back to TXT format
+
+## Installation
+
+```bash
+pip install rfc-editor
+```
+
+Or install from source:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+### Parse an RFC Document
+
+```python
+from rfc_editor import RFCEditor
+
+editor = RFCEditor()
+doc = editor.load("rfc1234.txt")
+
+# Or parse from string
+doc = editor.parse(rfc_content_string)
+```
+
+### Access Document Sections
+
+```python
+print(doc.rfc_number)  # RFC number
+print(doc.category)   # e.g., "Standards Track"
+print(doc.title)      # RFC title
+print(doc.abstract)  # Abstract content
+```
+
+### Edit Sections
+
+```python
+# Edit title
+editor.set_title("New Title")
+
+# Edit abstract
+editor.set_abstract("New abstract content...")
+
+# Edit status
+editor.set_status_of_memo("New status content...")
+
+# Edit copyright
+editor.set_copyright(2024, "Example Corp")
+
+# Edit TOC
+editor.set_toc("1. Introduction\n2. Body")
+
+# Update a numbered section
+editor.update_section("1", content="Updated introduction content...")
+
+# Add a new section
+editor.add_section("5", "New Section", "Section content...")
+
+# Delete a section
+editor.delete_section("1")
+
+# Edit by section title
+editor.set_section_by_title("Introduction", "New content...")
+```
+
+### Save the Document
+
+```python
+editor.save("output.txt")
+```
+
+### Convert to Dictionary
+
+```python
+data = editor.to_dict()
+print(data["title"])
+print(data["sections"])
+```
+
+## Development
+
+### Install Dev Dependencies
+
+```bash
+pip install -e ".[dev]"
+```
+
+### Run Tests
+
+```bash
+pytest tests/
+```
+
+### Run Linting
+
+```bash
+flake8 src/ tests/
+ruff check src/ tests/
+black --check src/ tests/
+```
+
+## Project Structure
+
+```
+rfc-editor/
+├── src/
+│   └── rfc_editor/
+│       └── __init__.py    # Main library code
+├── tests/
+│   ├── test_author.py
+│   ├── test_document.py
+│   ├── test_editor.py
+│   └── test_section.py
+├── pyproject.toml
+├── README.md
+├── .gitignore
+└── SPEC.md
+```
+
+## Version
+
+0.1.0.1
+
+## License
+
+MIT

rfc_editor-0.1.0.1/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rfc-editor"
+version = "0.1.0.1"
+description = "A Python library to parse and edit RFC TXT documents"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+authors = [
+    {name = "RFC Editor Team", email = "team@rfc-editor.example.com"}
+]
+keywords = ["rfc", "editor", "document", "ietf"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "flake8>=6.0",
+    "ruff>=0.1.0",
+    "black>=23.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/example/rfc-editor"
+Repository = "https://github.com/example/rfc-editor"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --tb=short"
+
+[tool.ruff]
+line-length = 72
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "UP", "B", "C4", "SIM"]
+ignore = ["E501"]
+
+[tool.black]
+line-length = 72
+target-version = ["py39"]
+
+[tool.flake8]
+max-line-length = 72
+extend-ignore = ["E501", "W503"]

rfc_editor-0.1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+