Rstcloth

Latest version: v0.6.0

Safety actively analyzes 642295 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 2 of 2

0.5.1

<!--- START AUTOGENERATED NOTES --->
Contents ([28](https://github.com/thclark/rstcloth/pull/28))

Operations
- Version increment for minor docs fixes
- Ensure coverage and test status is accessible on main branch

Chores
- Ensure coverage omits non-python directories

Other
- Update developer notes and badges in README
- Update version history to point to autogenerated releases
- Update default branch for coverage badge

<!--- END AUTOGENERATED NOTES --->

0.5.0

Contents ([27](https://github.com/thclark/rstcloth/pull/27))

Incorporates extensive and excellent work from amateja - Thanks very much Andrzej!

Features
- Use tabulate to replace table handling code as suggested in thclark/rstcloth9.
**BREAKING CHANGE:** tabulate is now a dependency.
- Add list-table support
- Store reStructuredText data into stream instead of list (faster, especially if piping into a file)
**BREAKING CHANGE:** The `RstCloth().data` property is no longer a list but a stream, by default going to sys.stdout
**BREAKING CHANGE:** The `write()` method was removed. Instead of:
py
your_doc.write(output_filename)

You can either open the doc in an `open` context:
py
with open(output_filename, "w", encoding="utf-8") as fp:
d = RstCloth(fp)
d.title('Example Use')

Or, for minimal changes to your code if you were already using `write`, create the doc as you would before, but stream into a memory buffer, then write to file at the end:
py
import io
d = RstCloth(stream=io.StringIO())
d.title('Example Use')
with open(output_filename, "w", encoding="utf-8") as fp:
fp.write(str(d))


- List table width and widths options expansion
- Admonitions added
- Bibliographic fields added
- Raw directives added
- Contents directive added
- Transition marker added

Enhancements

- Field structure and wrapping improved
**BREAKING-CHANGE:** Indentation and wrapping may change (although all documents should still render)
- Table indentation improved
- Parameter type verification changed to type declaration
- Type annotations added and docstrings supplemented
- Quick start documentation updated and unified

Fixes

- Fixed incorrect formatting of long bullet list point
- Paragraph folding fixed
- Directive folding fixed
- Bullet list item wrapping fixed
- Footnote reference should end with _

Refactoring

- Replaced different header methods with generic template
- Drop unused wrap parameter
- Reusing existing code for hyperlink formatting
- Variables names refactoring
- Drop unused BaseTestCase class
- Drop unused Table class
- YAML table translator removed

Testing

- Basic tests of RstCloth.table method added

0.4.0

<!--- START AUTOGENERATED NOTES --->
Contents ([25](https://github.com/thclark/rstcloth/pull/25))

New features
- Increment version for new __str__ methods

Uncategorised!
- replace print_content and print_table methods with __str__
- fix table __str__
- Merge pull request 16 from sp1thas/fix/replace-print-content-with-str-method

<!--- END AUTOGENERATED NOTES --->

0.3.1

Refactored redundant parts of the library and styled the remainder of the code.

0.3.0

Versions up to 0.2.6 were maintained by tychoish and had entered an unmaintained state.

With this version, thclark took over project, merged outstanding PRs from over the years, tidied up, sorted docs and devops, made tox
tests run and applied code style throughout.

Begun work of removing Python 2 code.

Still unstable. Pin your versions, people! Versions > 0.9 will adopt proper semver practice.

Page 2 of 2

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.