# markov_draftjs [](https://pypi.python.org/pypi/markov_draftjs) [](https://www.npmjs.com/package/markov_draftjs)
> Draft.js sample content generated with [Markov chains](https://en.wikipedia.org/wiki/Markov_chain) of [Project Gutenberg](https://www.gutenberg.org/) books.
This sample content is meant to be used while testing projects based on Draft.js, in particular [Draftail](https://www.draftail.org/) and [draftjs_exporter](https://github.com/springload/draftjs_exporter).
## Why
Sample content can be useful to stress-test and benchmark tools built to handle Draft.js content. For the exporter, this is a great way to reliably assess its performance.
The content from this repository isn't generated randomly – while the text and metadata values are fake, the content’s structure and the distribution of rich text formatting amongst the text is representative of that of 3 big CMS sites combined.
Here are rich text formats used in the content:
- Blocks
- `unstyled`
- `header-two`
- `header-three`
- `header-four`
- `ordered-list-item`, depth: 0 or 1
- `unordered-list-item`, depth: 0 or 1
- `atomic`
- Inline styles
- `BOLD`
- `ITALIC`
- Entities
- `LINK`, `MUTABLE` with `url` (URL), `linkType` (`page|external|email`), optionally `id` (number)
- `DOCUMENT`, `MUTABLE` with `label` (plain text), `id` (string containing a number)
- `IMAGE`, `IMMUTABLE` with `title` (plain text), `id` (string containing a number), `src` (URL)
- `HORIZONTAL_RULE`, `IMMUTABLE` without data
## Using the sample content
In order to simplify using the samples across multiple projects, they are published as packages on [npm](https://www.npmjs.com/package/markov_draftjs) and [PyPI](https://pypi.python.org/pypi/markov_draftjs).
```sh
# JavaScript projects.
npm install markov_draftjs
# Python projects.
pip install markov_draftjs
```
Then, in JavaScript:
```js
const contentStates = require("markov_draftjs");
```
And in Python:
```py
from markov_draftjs import get_content_sample
content_states = get_content_sample()
```
The sample content is also available from GitHub, eg. with RawGit (warning - big file): [https://cdn.rawgit.com/thibaudcolas/markov_draftjs/44827d98/markov_draftjs/content.json](https://cdn.rawgit.com/thibaudcolas/markov_draftjs/44827d98/markov_draftjs/content.json).
## Development
> Requirements: `virtualenv`, `pyenv`, `twine`
```sh
git clone git@github.com:thibaudcolas/markov_draftjs.git
cd markov_draftjs/
# Install the git hooks.
./.githooks/deploy
# Install dependencies
nvm install
npm install
# Unarchive sample text.
cd corpora/
tar -xzvf *.tar.gz
cd ..
# Install the Python environment.
virtualenv .venv
source ./.venv/bin/activate
make init
# Install required Python versions
pyenv install --skip-existing 3.10.0
# Make required Python versions available globally.
pyenv global system 3.10.0
# Generate new sample content.
npm run start
```
## Releases
- Use `irish-pub` to confirm the content of the npm package.
- Make a new branch for the release of the new version.
- Update the [CHANGELOG](CHANGELOG.md).
- Update the version number in `markov_draftjs/__init__.py`, and `package.json`, following semver.
- Make a PR and squash merge it.
- Back on main with the PR merged, use `make publish` (confirm, and enter your password) and `npm publish`.
- Finally, go to GitHub and create a release and a tag for the new version.
- Done!
## See also
- https://github.com/jsvine/markovify
- https://github.com/catseye/Guten-gutter
Raw data
{
"_id": null,
"home_page": "https://github.com/thibaudcolas/markov_draftjs",
"name": "markov-draftjs",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "draftjs,editor,markov,content",
"author": "Thibaud Colas",
"author_email": "thibaudcolas@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d4/2f/fd5adeadfc6ca0fa4d290021eb9cfbc3882d965d9601d6df3ef86904c676/markov_draftjs-0.2.0.tar.gz",
"platform": "",
"description": "# markov_draftjs [](https://pypi.python.org/pypi/markov_draftjs) [](https://www.npmjs.com/package/markov_draftjs)\n\n> Draft.js sample content generated with [Markov chains](https://en.wikipedia.org/wiki/Markov_chain) of [Project Gutenberg](https://www.gutenberg.org/) books.\n\nThis sample content is meant to be used while testing projects based on Draft.js, in particular [Draftail](https://www.draftail.org/) and [draftjs_exporter](https://github.com/springload/draftjs_exporter).\n\n## Why\n\nSample content can be useful to stress-test and benchmark tools built to handle Draft.js content. For the exporter, this is a great way to reliably assess its performance.\n\nThe content from this repository isn't generated randomly\u00a0\u2013\u00a0while the text and metadata values are fake, the content\u2019s structure and the distribution of rich text formatting amongst the text is representative of that of 3 big CMS sites combined.\n\nHere are rich text formats used in the content:\n\n- Blocks\n - `unstyled`\n - `header-two`\n - `header-three`\n - `header-four`\n - `ordered-list-item`, depth: 0 or 1\n - `unordered-list-item`, depth: 0 or 1\n - `atomic`\n- Inline styles\n - `BOLD`\n - `ITALIC`\n- Entities\n - `LINK`, `MUTABLE` with `url` (URL), `linkType` (`page|external|email`), optionally `id` (number)\n - `DOCUMENT`, `MUTABLE` with `label` (plain text), `id` (string containing a number)\n - `IMAGE`, `IMMUTABLE` with `title` (plain text), `id` (string containing a number), `src` (URL)\n - `HORIZONTAL_RULE`, `IMMUTABLE` without data\n\n## Using the sample content\n\nIn order to simplify using the samples across multiple projects, they are published as packages on [npm](https://www.npmjs.com/package/markov_draftjs) and [PyPI](https://pypi.python.org/pypi/markov_draftjs).\n\n```sh\n# JavaScript projects.\nnpm install markov_draftjs\n# Python projects.\npip install markov_draftjs\n```\n\nThen, in JavaScript:\n\n```js\nconst contentStates = require(\"markov_draftjs\");\n```\n\nAnd in Python:\n\n```py\nfrom markov_draftjs import get_content_sample\n\ncontent_states = get_content_sample()\n```\n\nThe sample content is also available from GitHub, eg. with RawGit (warning - big file): [https://cdn.rawgit.com/thibaudcolas/markov_draftjs/44827d98/markov_draftjs/content.json](https://cdn.rawgit.com/thibaudcolas/markov_draftjs/44827d98/markov_draftjs/content.json).\n\n## Development\n\n> Requirements: `virtualenv`, `pyenv`, `twine`\n\n```sh\ngit clone git@github.com:thibaudcolas/markov_draftjs.git\ncd markov_draftjs/\n\n# Install the git hooks.\n./.githooks/deploy\n\n# Install dependencies\nnvm install\nnpm install\n\n# Unarchive sample text.\ncd corpora/\ntar -xzvf *.tar.gz\ncd ..\n\n# Install the Python environment.\nvirtualenv .venv\nsource ./.venv/bin/activate\nmake init\n\n# Install required Python versions\npyenv install --skip-existing 3.10.0\n# Make required Python versions available globally.\npyenv global system 3.10.0\n\n# Generate new sample content.\nnpm run start\n```\n\n## Releases\n\n- Use `irish-pub` to confirm the content of the npm package.\n- Make a new branch for the release of the new version.\n- Update the [CHANGELOG](CHANGELOG.md).\n- Update the version number in `markov_draftjs/__init__.py`, and `package.json`, following semver.\n- Make a PR and squash merge it.\n- Back on main with the PR merged, use `make publish` (confirm, and enter your password) and `npm publish`.\n- Finally, go to GitHub and create a release and a tag for the new version.\n- Done!\n\n## See also\n\n- https://github.com/jsvine/markovify\n- https://github.com/catseye/Guten-gutter\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Draft.js sample content generated with Markov chains of Project Gutenberg books.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/thibaudcolas/markov_draftjs"
},
"split_keywords": [
"draftjs",
"editor",
"markov",
"content"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e796e79ec2b65397a4a1f4b2a7a1b10fb0e71ac61f1c337a1016c4bbe2ec21e2",
"md5": "14cb4ac599bdf93d43e2dfb2f11451fa",
"sha256": "7974e424bf99ee599aed6ff470bff35b4b594a0d69a8d75e2134b0c7cd78760f"
},
"downloads": -1,
"filename": "markov_draftjs-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "14cb4ac599bdf93d43e2dfb2f11451fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 509672,
"upload_time": "2022-01-03T21:43:07",
"upload_time_iso_8601": "2022-01-03T21:43:07.917896Z",
"url": "https://files.pythonhosted.org/packages/e7/96/e79ec2b65397a4a1f4b2a7a1b10fb0e71ac61f1c337a1016c4bbe2ec21e2/markov_draftjs-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d42ffd5adeadfc6ca0fa4d290021eb9cfbc3882d965d9601d6df3ef86904c676",
"md5": "413ee3f82d08c3160b57000657ba48fe",
"sha256": "aad60a213eba9ed6c572c7a9cd35ead47875759f789e57334a75b345ffcb919e"
},
"downloads": -1,
"filename": "markov_draftjs-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "413ee3f82d08c3160b57000657ba48fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 500771,
"upload_time": "2022-01-03T21:43:10",
"upload_time_iso_8601": "2022-01-03T21:43:10.742734Z",
"url": "https://files.pythonhosted.org/packages/d4/2f/fd5adeadfc6ca0fa4d290021eb9cfbc3882d965d9601d6df3ef86904c676/markov_draftjs-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-01-03 21:43:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thibaudcolas",
"github_project": "markov_draftjs",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "markov-draftjs"
}
JSON
