Skip to main content

Draft.js sample content generated with Markov chains of Project Gutenberg books.

Project description

markov_draftjs PyPI npm

Draft.js sample content generated with Markov chains of Project Gutenberg books.

This sample content is meant to be used while testing projects based on Draft.js, in particular Draftail and 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 and PyPI.

# JavaScript projects.
npm install markov_draftjs
# Python projects.
pip install markov_draftjs

Then, in JavaScript:

const contentStates = require("markov_draftjs");

And in Python:

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.

Development

Requirements: virtualenv, pyenv, twine

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.
  • 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markov_draftjs-2.0.0.tar.gz (501.2 kB view details)

Uploaded Source

Built Distribution

markov_draftjs-2.0.0-py3-none-any.whl (510.1 kB view details)

Uploaded Python 3

File details

Details for the file markov_draftjs-2.0.0.tar.gz.

File metadata

  • Download URL: markov_draftjs-2.0.0.tar.gz
  • Upload date:
  • Size: 501.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.1

File hashes

Hashes for markov_draftjs-2.0.0.tar.gz
Algorithm Hash digest
SHA256 392288751affb0fa4769e6d8e92e07108fec8be19b7b3823e384c6c49cc921e1
MD5 0b4d20b4a74f35446e0e07fb5937b949
BLAKE2b-256 7b5f432065db179ef0a90cb1478efd5e668851455ec02f739a90d8bd3b4c5e69

See more details on using hashes here.

File details

Details for the file markov_draftjs-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: markov_draftjs-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 510.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.1

File hashes

Hashes for markov_draftjs-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc30cad78b7be5bf284b96680d282da5802a1937c2a3b735a74ccd1f82835dd3
MD5 091eed42ec6b839128ae2b142f3d56a9
BLAKE2b-256 544da64d28624ba6ce6ac877ece427dda6957c4a1397cbd9e5350c98b2b7d96d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page