Draft.js sample content generated with Markov chains of Project Gutenberg books.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.githooks
corpora
markov_draftjs
tests
.coveragerc
.editorconfig
.gitignore
.nvmrc
.prettierignore
.travis.yml
CHANGELOG.md
LICENSE
MANIFEST.in
Makefile
README.md
example.py
package-lock.json
package.json
prettier.config.js
setup.cfg
setup.py
tox.ini

README.md

markov_draftjs PyPI npm Build Status

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.

What is this for?

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.

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 2.7.11
pyenv install --skip-existing 3.4.4
# Make required Python versions available globally.
pyenv global system 2.7.11 3.4.4

# 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 master 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