Repository files navigation

Acookiecutter template for packaging Javascript components with ReactPy

ReactPy is a framework for creating highly interactive web pages purely in Python. However,ReactPy also provides a way to natively interface with the Javascript ecosystem. Thisrepository defines a basic template for creating packages wich distribute Javascript foruse in ReactPy-based applications.

For more information about ReactPy refer to itsdocumentation.

Installcookiecutter withpip:

pip install cookiecutter

Then use this repostory template as a cookiecutter to initalize a repository:

cookiecutter https://github.com/reactive-python/reactpy-react-component-cookiecutter.git

As the template is being constructed you will be prompted to fill out the following information:

After this you should find a new directory named after the givenrepository_name.

The template generates the following files:

├── {python_package_name}│   ├── __init__.py│   └── example.py├── js│   ├── src│   │   ├── index.js│   ├── package.json│   ├── README.md│   └── rollup.config.js├── tests│   ├── __init__.py│   ├── conftest.py│   └── test_example.py├── .gitignore├── MANIFEST.in├── README.md├── setup.cfg└── setup.py

The key consituents of the generated repository are briefly described below:

To run the tests for this repository you'll need theChromeDriver in yourPATH. Once that'sdone, simplypip install the requirements:

pip install -r requirements.txt

And run thetest session withNox:

nox -stest

To open the browser when the tests run:

nox -stest