entangled-cli 2.1.1__tar.gz → 2.1.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/PKG-INFO +15 -3
  2. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/README.md +14 -2
  3. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/filedb.py +1 -1
  4. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/pyproject.toml +1 -1
  5. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/LICENSE +0 -0
  6. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/__init__.py +0 -0
  7. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/code_reader.py +0 -0
  8. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/commands/__init__.py +0 -0
  9. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/commands/brei.py +0 -0
  10. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/commands/new.py +0 -0
  11. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/commands/status.py +0 -0
  12. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/commands/stitch.py +0 -0
  13. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/commands/sync.py +0 -0
  14. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/commands/tangle.py +0 -0
  15. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/commands/watch.py +0 -0
  16. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/config/__init__.py +0 -0
  17. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/config/language.py +0 -0
  18. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/config/templates.py +0 -0
  19. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/config/version.py +0 -0
  20. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/construct.py +0 -0
  21. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/document.py +0 -0
  22. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/errors/__init__.py +0 -0
  23. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/errors/internal.py +0 -0
  24. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/errors/user.py +0 -0
  25. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/hooks/__init__.py +0 -0
  26. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/hooks/base.py +0 -0
  27. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/hooks/build.py +0 -0
  28. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/hooks/quarto_attributes.py +0 -0
  29. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/hooks/shebang.py +0 -0
  30. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/hooks/task.py +0 -0
  31. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/logging.py +0 -0
  32. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/main.py +0 -0
  33. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/markdown_reader.py +0 -0
  34. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/parsing.py +0 -0
  35. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/properties.py +0 -0
  36. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/py.typed +0 -0
  37. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/status.py +0 -0
  38. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/tangle.py +0 -0
  39. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/text_location.py +0 -0
  40. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/transaction.py +0 -0
  41. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/utility.py +0 -0
  42. {entangled_cli-2.1.1 → entangled_cli-2.1.2}/entangled/version.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: entangled-cli
3
- Version: 2.1.1
3
+ Version: 2.1.2
4
4
  Summary: Literate Programming toolbox
5
5
  Home-page: https://entangled.github.io/
6
6
  License: Apache 2
@@ -156,14 +156,26 @@ The `identifiers` are the tags that you may use in your code block header to ide
156
156
  And so on...
157
157
  ~~~
158
158
 
159
- If you have a `pyproject.toml` file, either because you use `poetry` to setup Entangled or because you're actually developing a Python project, you may want to put the configuration in `pyproject.toml` instead. Add a section `tools.entangled` like so:
159
+ #### Reading from `pyproject.toml`
160
+
161
+ If you have a `pyproject.toml` file, either because you use `poetry` to set up Entangled or because you're actually developing a Python project, you may want to put the configuration in `pyproject.toml` instead. Add a `tool.entangled` table like so:
160
162
 
161
163
  ```toml
162
- [[tools.entangled]]
164
+ [tool.entangled]
163
165
  version = "2.0"
164
166
  watch_list = ["docs/**/*.md"]
165
167
  ```
166
168
 
169
+ To add languages in your `pyproject.toml`, add `tool.entangled.languages` sections.
170
+ Be aware that these should be lists, not tables, so you will need to use double brackets, like so:
171
+
172
+ ```toml
173
+ [[tool.entangled.languages]]
174
+ name = "Java"
175
+ identifiers = ["java"]
176
+ comment = { open = "//" }
177
+ ```
178
+
167
179
  ## Hooks
168
180
  Entangled has a system of *hooks*: these add actions to the tangling process:
169
181
 
@@ -129,14 +129,26 @@ The `identifiers` are the tags that you may use in your code block header to ide
129
129
  And so on...
130
130
  ~~~
131
131
 
132
- If you have a `pyproject.toml` file, either because you use `poetry` to setup Entangled or because you're actually developing a Python project, you may want to put the configuration in `pyproject.toml` instead. Add a section `tools.entangled` like so:
132
+ #### Reading from `pyproject.toml`
133
+
134
+ If you have a `pyproject.toml` file, either because you use `poetry` to set up Entangled or because you're actually developing a Python project, you may want to put the configuration in `pyproject.toml` instead. Add a `tool.entangled` table like so:
133
135
 
134
136
  ```toml
135
- [[tools.entangled]]
137
+ [tool.entangled]
136
138
  version = "2.0"
137
139
  watch_list = ["docs/**/*.md"]
138
140
  ```
139
141
 
142
+ To add languages in your `pyproject.toml`, add `tool.entangled.languages` sections.
143
+ Be aware that these should be lists, not tables, so you will need to use double brackets, like so:
144
+
145
+ ```toml
146
+ [[tool.entangled.languages]]
147
+ name = "Java"
148
+ identifiers = ["java"]
149
+ comment = { open = "//" }
150
+ ```
151
+
140
152
  ## Hooks
141
153
  Entangled has a system of *hooks*: these add actions to the tangling process:
142
154
 
@@ -115,7 +115,7 @@ class FileDB:
115
115
  "source": list(map(str, self._source)),
116
116
  "target": list(map(str, self._target)),
117
117
  }
118
- json.dump(raw, open(FileDB.path(), "w"), indent=2)
118
+ json.dump(raw, open(FileDB.path(), "w"), indent=2, sort_keys=True)
119
119
 
120
120
  def changed(self) -> list[Path]:
121
121
  """List all target files that have changed w.r.t. the database."""
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "entangled-cli"
3
- version = "2.1.1"
3
+ version = "2.1.2"
4
4
  description = "Literate Programming toolbox"
5
5
  repository = "https://github.com/entangled/entangled.py"
6
6
  homepage = "https://entangled.github.io/"
File without changes