lyz/org-rw
1
0
Fork 0
forked from kenkeiras/org-rw
Code Pull Requests 1 Actions Activity

Add absence of dependencies as principle.

Browse Source
This commit is contained in:
Sergio Martínez Portela 2025-04-16 01:00:09 +02:00
parent f936bccf7f
commit 55fc87cfdc
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.org
View File

@ -8,9 +8,11 @@ A python library to parse, modify and save Org-mode files.
- Keep the original structure intact (indentation, spaces, format, ...). - Keep the original structure intact (indentation, spaces, format, ...).
** Principles ** Principles
- Data structures should be exposed as it's read on Emacs's org-mode or when in doubt as raw as possible. - Avoid any dependency outside of Python's standard library.
- Data in the objects should be modificable, as a way to update the document itself. *Consider this a Object-oriented design.* - Don't do anything outside of the scope of parsing/re-serializing Org-mode files.
- *Modification of the original text if there's no change is considered a bug (see [[id:7363ba38-1662-4d3c-9e83-0999824975b7][Known issues]]).* - *Modification of the original text if there's no change is considered a bug (see [[id:7363ba38-1662-4d3c-9e83-0999824975b7][Known issues]]).*
- Data structures should be exposed as it's read on Emacs's org-mode or when in doubt as raw as possible.
- Data in the objects should be modificable as a way to update the document itself. *Consider this a Object-oriented design.*
** Safety mechanism ** Safety mechanism
As this library is still in early development. Running it over files might As this library is still in early development. Running it over files might
produce unexpected changes on them. For this reason it's heavily recommended to produce unexpected changes on them. For this reason it's heavily recommended to

1
requirements.txt
View File

@ -1 +0,0 @@
# No external requirements at this point